Skip to content

Commit d26d65b

Browse files
authored
Update the debug.log descriptions to emphasize that change of format must not be changed (#1997) (#1998)
Cherry-picked from #1997
1 parent cfaf85e commit d26d65b

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

modules/ROOT/pages/monitoring/logging.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ For Debian and RPM packages run `journalctl --unit=neo4j`.
2626
| `true`
2727

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

@@ -179,8 +181,11 @@ The following example shows the default configuration of the _server-logs.xml_ f
179181
<!--
180182
This is a log4j 2 configuration file.
181183
182-
It is highly recommended to keep the original "debug.log" as is, to make sure enough data is captured in case
183-
of errors in a format that neo4j developers can work with.
184+
Please do not alter the original debug.log.
185+
Changing the debug.log format can interfere with Neo4j's ability to offer customer support and invalidate your support warranty.
186+
187+
If you require the debug.log messages in a different format, you can copy the Appender and change the filename.
188+
See Neo4j documentation for details.
184189
185190
All configuration values can be queried with the lookup prefix "config:". You can, for example, resolve
186191
the path to your neo4j home directory with ${config:dbms.directories.neo4j_home}.
@@ -190,7 +195,7 @@ The following example shows the default configuration of the _server-logs.xml_ f
190195
-->
191196
<Configuration status="ERROR" monitorInterval="30" packages="org.neo4j.logging.log4j"> \ #<1>
192197
<Appenders> \ #<2>
193-
<!-- Default debug.log, please keep -->
198+
<!-- Neo4j debug.log,do not change. Required by Neo4j customer support. -->
194199
<RollingRandomAccessFile name="DebugLog" fileName="${config:server.directories.logs}/debug.log" \ #<3>
195200
filePattern="$${config:server.directories.logs}/debug.log.%02i"> \ #<4>
196201
<Neo4jDebugLogLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSSZ}{GMT+0} %-5p [%c{1.}] %m%n"/> \ #<5>

0 commit comments

Comments
 (0)