Skip to content

Document executionPlanCacheKeyHash and executableQueryCacheHit #2064

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
merged 3 commits into from
Jan 22, 2025
Merged

Document executionPlanCacheKeyHash and executableQueryCacheHit #2064

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0ecf344
Document executionPlanCacheKeyHash and executableQueryCacheHit
renetapopova Jan 20, 2025
ee5ae7f
Update modules/ROOT/pages/monitoring/logging.adoc
renetapopova Jan 22, 2025
c6594dc
Update modules/ROOT/pages/monitoring/logging.adoc
renetapopova Jan 22, 2025
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
12 changes: 12 additions & 0 deletions modules/ROOT/pages/monitoring/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1197,6 +1197,7 @@ If the type of the log entry is `query`, these additional fields are available:

| id
| The query ID.
The ID is incremental, starting from 1 and resetting upon every Neo4j restart.
Included when xref:configuration/configuration-settings.adoc#config_db.logs.query.enabled[`db.logs.query.enabled`] is `VERBOSE`.

| elapsedTimeMs
Expand Down Expand Up @@ -1261,6 +1262,16 @@ See <<gql-error-information, GQL error information>> for details on the contents
| The query plan.
Included when xref:configuration/configuration-settings.adoc#config_db.logs.query.plan_description_enabled[`db.logs.query.plan_description_enabled`] is `true`.

| executionPlanCacheKeyHash
| The 32-bit hash of the cache key used to cache the execution plan.
It is a fixed-length 8-character string of a hex-encoded integer value.
Enabled by default only in the JSON format.
If multiple query executions use the same cached execution plan, their hashes should match.
For `event=start`, the value is `00000000`.

| executableQueryCacheHit
| Whether the query string matched a cached execution plan.

|===

If the type of the log entry is `transaction`, the following additional fields are available:
Expand All @@ -1286,6 +1297,7 @@ Either same as `authenticatedUser` or an impersonated user.

| transactionId
| ID of the transaction.

|===

[[gql-error-information]]
Expand Down
Loading