Skip to content

Commit 5ca5987

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 d6d022d commit 5ca5987

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

111111
1. Via the command-line: `-E <name of logging hierarchy>=<level>` (e.g.,
112-
`-E logger.org.elasticsearch.transport=trace`). This is most appropriate when
112+
`-E logger.org.elasticsearch.discovery=debug`). This is most appropriate when
113113
you are temporarily debugging a problem on a single node (for example, a
114114
problem with startup, or during development).
115115
2. Via `elasticsearch.yml`: `<name of logging hierarchy>: <level>` (e.g.,
116-
`logger.org.elasticsearch.transport: trace`). This is most appropriate when
116+
`logger.org.elasticsearch.discovery: debug`). This is most appropriate when
117117
you are temporarily debugging a problem but are not starting Elasticsearch
118118
via the command-line (e.g., via a service) or you want a logging level
119119
adjusted on a more permanent basis.
@@ -138,7 +138,7 @@ For example:
138138
PUT /_cluster/settings
139139
{
140140
"transient": {
141-
"logger.org.elasticsearch.transport": "trace"
141+
"logger.org.elasticsearch.discovery": "DEBUG"
142142
}
143143
}
144144
-------------------------------
@@ -161,8 +161,8 @@ For example:
161161

162162
[source,properties]
163163
--------------------------------------------------
164-
logger.transport.name = org.elasticsearch.transport
165-
logger.transport.level = trace
164+
logger.discovery.name = org.elasticsearch.discovery
165+
logger.discovery.level = debug
166166
--------------------------------------------------
167167

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

0 commit comments

Comments
 (0)