log_leveledit

Sets the logging level for the agent. This option is case-insensitive.

Valid options: OFF, ERROR, CRITICAL, WARN, WARNING, INFO, DEBUG, TRACE

log_fileedit

Sets the path of the agent logs. The special value _AGENT_HOME_ is a placeholder for the folder the elastic-apm-agent.jar is in. Example: _AGENT_HOME_/logs/elastic-apm.log

When set to the special value System.out, the logs are sent to standard out.

log_ecs_reformatting ( [1.22.0] Added in 1.22.0. experimental)edit

Specifying whether and how the agent should automatically reformat application logs into ECS-compatible JSON, suitable for ingestion into Elasticsearch for further Log analysis. This functionality is available for log4j1, log4j2, Logback and java.util.logging. The ECS log lines will include active trace/transaction/error IDs, if there are such.

This option only applies to pattern layouts/formatters by default. See also log_ecs_formatter_allow_list. To properly ingest and parse ECS JSON logs, follow the getting started guide.

Available options:

Valid options: OFF, SHADE, REPLACE, OVERRIDE

log_ecs_reformatting_additional_fields ( [1.26.0] Added in 1.26.0. )edit

A comma-separated list of key-value pairs that will be added as additional fields to all log events. Takes the format key=value[,key=value[,...]], for example: key1=value1,key2=value2. Only relevant if log_ecs_reformatting is set to any option other than OFF. Additional fields are currently not supported for direct log sending through the agent.

log_ecs_formatter_allow_listedit

Only formatters that match an item on this list will be automatically reformatted to ECS when log_ecs_reformatting is set to any option other than OFF. A formatter is the logging-framework-specific entity that is responsible for the formatting of log events. For example, in log4j it would be a Layout implementation, whereas in Logback it would be an Encoder implementation.

This option supports the wildcard *, which matches zero or more characters. Examples: /foo/*/bar/*/baz*, *foo*. Matching is case insensitive by default. Prepending an element with (?-i) makes the matching case sensitive.

log_ecs_reformatting_diredit

If log_ecs_reformatting is set to SHADE or REPLACE, the shade log files will be written alongside the original logs in the same directory by default. Use this configuration in order to write the shade logs into an alternative destination. Omitting this config or setting it to an empty string will restore the default behavior. If relative path is used, this path will be used relative to the original logs directory.

log_file_size ( [1.17.0] Added in 1.17.0. )edit

The size of the log file.

The agent always keeps one history file so that the max total log file size is twice the value of this setting.

log_format_sout ( [1.17.0] Added in 1.17.0. )edit

Defines the log format when logging to System.out.

When set to JSON, the agent will format the logs in an ECS-compliant JSON format where each log event is serialized as a single line.

Valid options: PLAIN_TEXT, JSON

log_format_file ( [1.17.0] Added in 1.17.0. )edit

Defines the log format when logging to a file.

When set to JSON, the agent will format the logs in an ECS-compliant JSON format where each log event is serialized as a single line.

Valid options: PLAIN_TEXT, JSON

log_sending ( [1.36.0] Added in 1.36.0. experimental)edit

Sends agent and application logs directly to APM Server.

Note that logs can get lost if the agent can’t keep up with the logs, if APM Server is not available, or if Elasticsearch can’t index the logs fast enough.

For better delivery guarantees, it’s recommended to ship ECS JSON log files with Filebeat See also log_ecs_reformatting. Log sending does not currently support custom MDC fields, log_ecs_reformatting and shipping the logs with Filebeat must be used if custom MDC fields are required.