Skip to content

Update the debug.log descriptions to emphasize that change of format must not be changed #1997

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 2 commits into from
Nov 29, 2024
Merged

Update the debug.log descriptions to emphasize that change of format must not be changed #1997

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2dadfa4
Update the debug.log descriptions to emphasize that change of format …
renetapopova Nov 29, 2024
8275f87
add file formatting
renetapopova Nov 29, 2024
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
13 changes: 9 additions & 4 deletions modules/ROOT/pages/monitoring/logging.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ For Debian and RPM packages run `journalctl --unit=neo4j`.
| `true`

| _debug.log_
| Logs information that is useful when investigating problems with Neo4j. It is highly recommended to keep it enabled.
| Log information required by Neo4j Customer Support to investigate problems.
It is highly recommended to keep it enabled and not to alter the _debug.log_ format.
If you require the _debug.log_ messages in a different format, create an additional Appender.
| xref:configuration/configuration-settings.adoc#config_server.logs.debug.enabled[`server.logs.debug.enabled`]
| `true`

Expand Down Expand Up @@ -179,8 +181,11 @@ The following example shows the default configuration of the _server-logs.xml_ f
<!--
This is a log4j 2 configuration file.

It is highly recommended to keep the original "debug.log" as is, to make sure enough data is captured in case
of errors in a format that neo4j developers can work with.
Please do not alter the original debug.log.
Changing the debug.log format can interfere with Neo4j's ability to offer customer support and invalidate your support warranty.

If you require the debug.log messages in a different format, you can copy the Appender and change the filename.
See Neo4j documentation for details.

All configuration values can be queried with the lookup prefix "config:". You can, for example, resolve
the path to your neo4j home directory with ${config:dbms.directories.neo4j_home}.
Expand All @@ -190,7 +195,7 @@ The following example shows the default configuration of the _server-logs.xml_ f
-->
<Configuration status="ERROR" monitorInterval="30" packages="org.neo4j.logging.log4j"> \ #<1>
<Appenders> \ #<2>
<!-- Default debug.log, please keep -->
<!-- Neo4j debug.log,do not change. Required by Neo4j customer support. -->
<RollingRandomAccessFile name="DebugLog" fileName="${config:server.directories.logs}/debug.log" \ #<3>
filePattern="$${config:server.directories.logs}/debug.log.%02i"> \ #<4>
<Neo4jDebugLogLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSSZ}{GMT+0} %-5p [%c{1.}] %m%n"/> \ #<5>
Expand Down