Skip to content

Conversation

@renetapopova
Copy link
Collaborator

No description provided.

| 03N85
| Neo.ClientNotification.Cluster.ServerCaughtUp
* A new JSON template is available for the query log, which is the default set in _server_log.xml_.
It contains the `errorInfo` entry, but not the `failureReason` entry, which is switched off by default.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, it makes sense, but maybe to here: https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information.

True! Much better

Copy link
Collaborator Author

@renetapopova renetapopova Nov 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, the new thing here is the new JSON template, which is the default set in server_logs.xml. The other information is not so important. errorInfo is introduced in 5.25 and failureReason entry is deprecated in 2025.05..

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In other words, I am not sure where to link to.

| 03N85
| Neo.ClientNotification.Cluster.ServerCaughtUp
* A new JSON template is available for the query log, which is the default set in _server_logs.xml_.
It contains the `errorInfo` entry, but not the `failureReason` entry, which is switched off by default.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
It contains the `errorInfo` entry, but not the `failureReason` entry, which is switched off by default.
It contains the `errorInfo` entry, but not the `failureReason` entry, which is switched off by default starting from 2025.05.
For more details about the JSON template for the query log, refer to the link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#_json_format_log_entries[Operations manual -> Monitoring -> Logging].
To learn more about the JSON object `errorInfo` in the query log, visit the link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations manual -> Logging -> GQL error information].

Copy link
Collaborator

@NataliaIvakina NataliaIvakina Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, it would be to link to the table Table 10. JSON format log entries for log type query.
But I still think it's enough to link to the JSON format log entries because we talk about the changes made to the JSON template.

GQL error information is part of JSON format log entries but it has the same 4th level which is understandable. It would be too much to place it on the 5th level.

We can add a line here speaking about the GQL error specifically

|===
| GQLSTATUS
| Neo4j code
= Changes and deprecations
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually, now I'm starting thinking that we should place the information about the deprecated failureReason under the separate title.

== 2025.05

Starting from 2025.05, the `failureReason` in the JSON template of the query log, is deprecated and switched off by default.

Use the `errorInfo` entry instead.
This was introduced in 5.25.

To learn more about the JSON object `errorInfo` in the query log, visit the link:https://neo4j.com/docs/operations-manual/current/monitoring/logging/#gql-error-information[Operations manual -> Logging -> GQL error information].

@neo4j-docops-agent
Copy link
Collaborator

This PR includes documentation updates
View the updated docs at https://neo4j-docs-status-codes-415.surge.sh

Updated pages:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants