Skip to content

Commit dda9476

Browse files
committed
Give a less dangerous example of logger config (elastic#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 6738af6 commit dda9476

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
@@ -142,11 +142,11 @@ documentation].
142142
There are four ways to configuring logging levels, each having situations in which they are appropriate to use.
143143

144144
1. Via the command-line: `-E <name of logging hierarchy>=<level>` (e.g.,
145-
`-E logger.org.elasticsearch.transport=trace`). This is most appropriate when
145+
`-E logger.org.elasticsearch.discovery=debug`). This is most appropriate when
146146
you are temporarily debugging a problem on a single node (for example, a
147147
problem with startup, or during development).
148148
2. Via `elasticsearch.yml`: `<name of logging hierarchy>: <level>` (e.g.,
149-
`logger.org.elasticsearch.transport: trace`). This is most appropriate when
149+
`logger.org.elasticsearch.discovery: debug`). This is most appropriate when
150150
you are temporarily debugging a problem but are not starting Elasticsearch
151151
via the command-line (e.g., via a service) or you want a logging level
152152
adjusted on a more permanent basis.
@@ -171,7 +171,7 @@ For example:
171171
PUT /_cluster/settings
172172
{
173173
"transient": {
174-
"logger.org.elasticsearch.transport": "trace"
174+
"logger.org.elasticsearch.discovery": "DEBUG"
175175
}
176176
}
177177
-------------------------------
@@ -193,8 +193,8 @@ For example:
193193

194194
[source,properties]
195195
--------------------------------------------------
196-
logger.transport.name = org.elasticsearch.transport
197-
logger.transport.level = trace
196+
logger.discovery.name = org.elasticsearch.discovery
197+
logger.discovery.level = debug
198198
--------------------------------------------------
199199

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

0 commit comments

Comments
 (0)