Logging

Logging

You can use Elasticsearch’s application logs to monitor your cluster and diagnose issues. If you run Elasticsearch as a service, the default location of the logs varies based on your platform and installation method:

Docker Debian (APT) RPM macOS Brew Linux Windows .zip

On Docker, log messages go to the console and are handled by the configured Docker logging driver. To access logs, run docker logs.

For Debian installations, Elasticsearch writes logs to /var/log/elasticsearch.

For RPM installations, Elasticsearch writes logs to /var/log/elasticsearch.

For macOS .tar.gz installations, Elasticsearch writes logs to $ES_HOME/logs.

Files in $ES_HOME risk deletion during an upgrade. In production, we strongly recommend you set path.logs to a location outside of $ES_HOME. See Path settings.

For macOS Homebrew installations, Elasticsearch writes logs to /usr/local/var/log/elasticsearch.

For Linux .tar.gz installations, Elasticsearch writes logs to $ES_HOME/logs.

Files in $ES_HOME risk deletion during an upgrade. In production, we strongly recommend you set path.logs to a location outside of $ES_HOME. See Path settings.

For Windows .zip installations, Elasticsearch writes logs to %ES_HOME%\logs.

Files in %ES_HOME% risk deletion during an upgrade. In production, we strongly recommend you set path.logs to a location outside of %ES_HOME%` . See Path settings.

If you run Elasticsearch from the command line, Elasticsearch prints logs to the standard output (stdout).

Logging configuration

Elastic strongly recommends using the Log4j 2 configuration that is shipped by default.

Elasticsearch uses Log4j 2 for logging. Log4j 2 can be configured using the log4j2.properties file. Elasticsearch exposes three properties, ${sys:es.logs.base_path}, ${sys:es.logs.cluster_name}, and ${sys:es.logs.node_name} that can be referenced in the configuration file to determine the location of the log files. The property ${sys:es.logs.base_path} will resolve to the log directory, ${sys:es.logs.cluster_name} will resolve to the cluster name (used as the prefix of log filenames in the default configuration), and ${sys:es.logs.node_name} will resolve to the node name (if the node name is explicitly set).

For example, if your log directory (path.logs) is /var/log/elasticsearch and your cluster is named production then ${sys:es.logs.base_path} will resolve to /var/log/elasticsearch and ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}.log will resolve to /var/log/elasticsearch/production.log.

  1. ######## Server JSON ############################
  2. appender.rolling.type = RollingFile 
  3. appender.rolling.name = rolling
  4. appender.rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.json 
  5. appender.rolling.layout.type = ESJsonLayout 
  6. appender.rolling.layout.type_name = server 
  7. appender.rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.json.gz 
  8. appender.rolling.policies.type = Policies
  9. appender.rolling.policies.time.type = TimeBasedTriggeringPolicy 
  10. appender.rolling.policies.time.interval = 1 
  11. appender.rolling.policies.time.modulate = true 
  12. appender.rolling.policies.size.type = SizeBasedTriggeringPolicy 
  13. appender.rolling.policies.size.size = 256MB 
  14. appender.rolling.strategy.type = DefaultRolloverStrategy
  15. appender.rolling.strategy.fileIndex = nomax
  16. appender.rolling.strategy.action.type = Delete 
  17. appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path}
  18. appender.rolling.strategy.action.condition.type = IfFileName 
  19. appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-* 
  20. appender.rolling.strategy.action.condition.nested_condition.type = IfAccumulatedFileSize 
  21. appender.rolling.strategy.action.condition.nested_condition.exceeds = 2GB 
  22. ################################################

Configure the RollingFile appender

Log to /var/log/elasticsearch/production_server.json

Use JSON layout.

type_name is a flag populating the type field in a ESJsonLayout. It can be used to distinguish different types of logs more easily when parsing them.

Roll logs to /var/log/elasticsearch/production-yyyy-MM-dd-i.json; logs will be compressed on each roll and i will be incremented

Use a time-based roll policy

Roll logs on a daily basis

Align rolls on the day boundary (as opposed to rolling every twenty-four hours)

Using a size-based roll policy

Roll logs after 256 MB

Use a delete action when rolling logs

Only delete logs matching a file pattern

The pattern is to only delete the main logs

Only delete if we have accumulated too many compressed logs

The size condition on the compressed logs is 2 GB

  1. ######## Server -  old style pattern ###########
  2. appender.rolling_old.type = RollingFile
  3. appender.rolling_old.name = rolling_old
  4. appender.rolling_old.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.log 
  5. appender.rolling_old.layout.type = PatternLayout
  6. appender.rolling_old.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n
  7. appender.rolling_old.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.old_log.gz

The configuration for old style pattern appenders. These logs will be saved in .log files and if archived will be in .log.gz files. Note that these should be considered deprecated and will be removed in the future.

Log4j’s configuration parsing gets confused by any extraneous whitespace; if you copy and paste any Log4j settings on this page, or enter any Log4j configuration in general, be sure to trim any leading and trailing whitespace.

Note than you can replace .gz by .zip in appender.rolling.filePattern to compress the rolled logs using the zip format. If you remove the .gz extension then logs will not be compressed as they are rolled.

If you want to retain log files for a specified period of time, you can use a rollover strategy with a delete action.

  1. appender.rolling.strategy.type = DefaultRolloverStrategy 
  2. appender.rolling.strategy.action.type = Delete 
  3. appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path} 
  4. appender.rolling.strategy.action.condition.type = IfFileName 
  5. appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-* 
  6. appender.rolling.strategy.action.condition.nested_condition.type = IfLastModified 
  7. appender.rolling.strategy.action.condition.nested_condition.age = 7D

Configure the DefaultRolloverStrategy

Configure the Delete action for handling rollovers

The base path to the Elasticsearch logs

The condition to apply when handling rollovers

Delete files from the base path matching the glob ${sys:es.logs.cluster_name}-*; this is the glob that log files are rolled to; this is needed to only delete the rolled Elasticsearch logs but not also delete the deprecation and slow logs

A nested condition to apply to files matching the glob

Retain logs for seven days

Multiple configuration files can be loaded (in which case they will get merged) as long as they are named log4j2.properties and have the Elasticsearch config directory as an ancestor; this is useful for plugins that expose additional loggers. The logger section contains the java packages and their corresponding log level. The appender section contains the destinations for the logs. Extensive information on how to customize logging and all the supported appenders can be found on the Log4j documentation.

Configuring logging levels

Each Java package in the Elasticsearch source code has a related logger. For example, the org.elasticsearch.discovery package has logger.org.elasticsearch.discovery for logs related to the discovery process.

To get more or less verbose logs, use the cluster update settings API to change the related logger’s log level. Each logger accepts Log4j 2’s built-in log levels, from least to most verbose: OFF, FATAL, ERROR, WARN, INFO, DEBUG, and TRACE. The default log level is INFO. Messages logged at higher verbosity levels (DEBUG and TRACE) are only intended for expert use.

  1. PUT /_cluster/settings
  2. {
  3.   "persistent": {
  4.     "logger.org.elasticsearch.discovery": "DEBUG"
  5.   }
  6. }

Other ways to change log levels include:

  1. elasticsearch.yml:

    1. logger.org.elasticsearch.discovery: DEBUG

    This is most appropriate when debugging a problem on a single node.

  2. log4j2.properties:

    1. logger.discovery.name = org.elasticsearch.discovery
    2. logger.discovery.level = debug

    This is most appropriate when you already need to change your Log4j 2 configuration for other reasons. For example, you may want to send logs for a particular logger to another file. However, these use cases are rare.

Deprecation logging

Elasticsearch also writes deprecation logs to the log directory. These logs record a message when you use deprecated Elasticsearch functionality. You can use the deprecation logs to update your application before upgrading Elasticsearch to a new major version.

By default, Elasticsearch rolls and compresses deprecation logs at 1GB. The default configuration preserves a maximum of five log files: four rolled logs and an active log.

Elasticsearch emits deprecation log messages at the CRITICAL level. Those messages are indicating that a used deprecation feature will be removed in a next major version. Deprecation log messages at the WARN level indicates that a less critical feature was used, it won’t be removed in next major version, but might be removed in the future.

To stop writing deprecation log messages, set logger.deprecation.level to OFF in log4j2.properties :

  1. logger.deprecation.level = OFF

Alternatively, you can change the logging level dynamically:

  1. PUT /_cluster/settings
  2. {
  3.   "persistent": {
  4.     "logger.org.elasticsearch.deprecation": "OFF"
  5.   }
  6. }

Refer to Configuring logging levels.

You can identify what is triggering deprecated functionality if X-Opaque-Id was used as an HTTP header. The user ID is included in the X-Opaque-ID field in deprecation JSON logs.

  1. {
  2.   "type": "deprecation",
  3.   "timestamp": "2019-08-30T12:07:07,126+02:00",
  4.   "level": "WARN",
  5.   "component": "o.e.d.r.a.a.i.RestCreateIndexAction",
  6.   "cluster.name": "distribution_run",
  7.   "node.name": "node-0",
  8.   "message": "[types removal] Using include_type_name in create index requests is deprecated. The parameter will be removed in the next major version.",
  9.   "x-opaque-id": "MY_USER_ID",
  10.   "cluster.uuid": "Aq-c-PAeQiK3tfBYtig9Bw",
  11.   "node.id": "D7fUYfnfTLa2D7y-xw6tZg"
  12. }

Deprecation logs can be indexed into .logs-deprecation.elasticsearch-default data stream cluster.deprecation_indexing.enabled setting is set to true.

Deprecation logs throttling

Deprecation logs are deduplicated based on a deprecated feature key and x-opaque-id so that if a feature is repeatedly used, it will not overload the deprecation logs. This applies to both indexed deprecation logs and logs emitted to log files. You can disable the use of x-opaque-id in throttling by changing cluster.deprecation_indexing.x_opaque_id_used.enabled to false See RateLimitingFilter

JSON log format

To make parsing Elasticsearch logs easier, logs are now printed in a JSON format. This is configured by a Log4J layout property appender.rolling.layout.type = ESJsonLayout. This layout requires a type_name attribute to be set which is used to distinguish logs streams when parsing.

  1. appender.rolling.layout.type = ESJsonLayout
  2. appender.rolling.layout.type_name = server

Each line contains a single JSON document with the properties configured in ESJsonLayout. See this class javadoc for more details. However if a JSON document contains an exception, it will be printed over multiple lines. The first line will contain regular properties and subsequent lines will contain the stacktrace formatted as a JSON array.

You can still use your own custom layout. To do that replace the line appender.rolling.layout.type with a different layout. See sample below:

  1. appender.rolling.type = RollingFile
  2. appender.rolling.name = rolling
  3. appender.rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.log
  4. appender.rolling.layout.type = PatternLayout
  5. appender.rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %.-10000m%n
  6. appender.rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.log.gz