Skip to content

Add a note on instrumentation logging not having access to engine timing #199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dondonz merged 1 commit into from
Aug 6, 2025
Merged

Add a note on instrumentation logging not having access to engine timing #199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions documentation/profiler.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,6 @@ if (profilerResult != null) {
}
```

You could alternatively access and log the request's `ProfilerResult` from an `Instrumentation`.

## Understanding the Profiler Results

A great way to get a quick overview about `ProfilerResult` is by using the `shortSummaryMap()` method. It returns a map with key metrics about the execution, which you can use for logging. Let's break down what each key means.
Expand Down Expand Up @@ -110,3 +108,9 @@ Here's what the result types mean:
| `COMPLETABLE_FUTURE_COMPLETED` | The DataFetcher returned a `CompletableFuture` that was already completed when it was returned. |
| `COMPLETABLE_FUTURE_NOT_COMPLETED` | The DataFetcher returned an incomplete `CompletableFuture`. |
| `MATERIALIZED` | The DataFetcher returned a simple value (i.e., not a `CompletableFuture`). |

### A note on engine timing statistics logged from an `Instrumentation`

If you're logging the `ProfilerResult` from an `Instrumentation`, note that engine timing statistics such as `startTimeNs`, `endTimeNs`, `totalRunTimeNs`, `engineTotalRunningTimeNs` will be set to `0`. This is because the timing is set after all `Instrumentation`s have run, so it is not available from within an `Instrumentation`.

Apart from engine timing information, all other `ProfilerResult` information is still valid if accessed from within an `Instrumentation`.