Skip to content

Commit 6d16713

Browse files
committed
Give a less dangerous example of logger config (#66318)
Today the docs use `logger.org.elasticsearch.transport: TRACE` as the example for adjusting the logger config. This is a dangerous thing to suggest since that's one of the most verbose loggers we have. An accidental copy-and-paste of this example into a busy cluster can cause damage. This commit suggests `logger.org.elasticsearch.discovery: DEBUG` instead, which is much more benign.
1 parent 1fa3f13 commit 6d16713

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/reference/setup/logging-config.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,11 @@ documentation].
127127
There are four ways to configuring logging levels, each having situations in which they are appropriate to use.
128128

129129
1. Via the command-line: `-E <name of logging hierarchy>=<level>` (e.g.,
130-
`-E logger.org.elasticsearch.transport=trace`). This is most appropriate when
130+
`-E logger.org.elasticsearch.discovery=debug`). This is most appropriate when
131131
you are temporarily debugging a problem on a single node (for example, a
132132
problem with startup, or during development).
133133
2. Via `elasticsearch.yml`: `<name of logging hierarchy>: <level>` (e.g.,
134-
`logger.org.elasticsearch.transport: trace`). This is most appropriate when
134+
`logger.org.elasticsearch.discovery: debug`). This is most appropriate when
135135
you are temporarily debugging a problem but are not starting Elasticsearch
136136
via the command-line (e.g., via a service) or you want a logging level
137137
adjusted on a more permanent basis.
@@ -156,7 +156,7 @@ For example:
156156
PUT /_cluster/settings
157157
{
158158
"transient": {
159-
"logger.org.elasticsearch.transport": "trace"
159+
"logger.org.elasticsearch.discovery": "DEBUG"
160160
}
161161
}
162162
-------------------------------
@@ -179,8 +179,8 @@ For example:
179179

180180
[source,properties]
181181
--------------------------------------------------
182-
logger.transport.name = org.elasticsearch.transport
183-
logger.transport.level = trace
182+
logger.discovery.name = org.elasticsearch.discovery
183+
logger.discovery.level = debug
184184
--------------------------------------------------
185185

186186
This is most appropriate when you need fine-grained control over the logger (for

0 commit comments

Comments
 (0)