Skip to content

Commit

Permalink
Update the debug.log descriptions to emphasize that change of format …
Browse files Browse the repository at this point in the history
…must not be changed (neo4j#1997)
  • Loading branch information
renetapopova committed Nov 29, 2024
1 parent cfaf85e commit f704d76
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions modules/ROOT/pages/monitoring/logging.adoc
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

0 comments on commit f704d76

Please sign in to comment.