Skip to content

Commit

Permalink
Give a less dangerous example of logger config (#66318)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
DaveCTurner committed Dec 15, 2020
1 parent 63f8bc1 commit 305813b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/reference/setup/logging-config.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -127,11 +127,11 @@ documentation].
There are four ways to configuring logging levels, each having situations in which they are appropriate to use.

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

[source,properties]
--------------------------------------------------
logger.transport.name = org.elasticsearch.transport
logger.transport.level = trace
logger.discovery.name = org.elasticsearch.discovery
logger.discovery.level = debug
--------------------------------------------------

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

0 comments on commit 305813b

Please sign in to comment.