- APM Guide: other versions:
- What is APM?
- Components and documentation
- Quick start
- Data Model
- Features
- How-to guides
- OpenTelemetry integration
- Manage storage
- Input settings
- Secure communication with APM agents
- API
- Troubleshooting
- Upgrade
- Release notes
- Legacy APM Overview
- Components and documentation
- Quick start guide
- Data Model
- Features
- Troubleshooting
- Breaking changes
- 7.15.0 APM Breaking changes
- 7.14.0 APM Breaking changes
- 7.13.0 APM Breaking changes
- 7.12.0 APM Breaking changes
- 7.11.0 APM Breaking changes
- 7.10.0 APM Breaking changes
- 7.9.0 APM Breaking changes
- 7.8.0 APM Breaking changes
- 7.7.0 APM Breaking changes
- 7.6.0 APM Breaking changes
- 7.5.0 APM Breaking changes
- 7.4.0 APM Breaking changes
- 7.3.0 APM Breaking changes
- 7.2.0 APM Breaking changes
- 7.1.0 APM Breaking changes
- 7.0.0 APM Breaking changes
- 6.8.0 APM Breaking changes
- 6.7.0 APM Breaking changes
- 6.6.0 APM Breaking changes
- 6.5.0 APM Breaking changes
- 6.4.0 APM Breaking changes
- Legacy APM Server Reference
- Get started
- Set up
- How-to guides
- Configure
- Secure
- Monitor
- API
- Explore data in Elasticsearch
- Exported fields
- APM Application Metrics fields
- APM Error fields
- APM Profile fields
- APM Sourcemap fields
- APM Span fields
- APM Span Metrics fields
- APM Transaction fields
- APM Transaction Metrics fields
- APM Transaction Metrics fields
- Beat fields
- Cloud provider metadata fields
- Docker fields
- ECS fields
- Host fields
- Kubernetes fields
- Process fields
- System Metrics fields
- Troubleshoot
Configure the Console output
editConfigure the Console output
editThis documentation refers to configuring the standalone (legacy) APM Server. This method of running APM Server will be deprecated and removed in a future release. Please consider upgrading to Fleet and the APM integration.
The Console output writes events in JSON format to stdout.
The Console output should be used only for debugging issues as it can produce a large amount of logging data.
To use this output, edit the APM Server configuration file to disable the Elasticsearch
output by commenting it out, and enable the console output by adding output.console
.
Example configuration:
output.console: pretty: true
Configure the Kibana output
editThe APM integration is required to set up and manage APM templates, policies, and pipelines. To confirm the integration is installed, APM Server will poll either Elasticsearch or Kibana on startup. When using a non-Elasticsearch output, APM Server requires access to Kibana via the Kibana endpoint.
Example configuration:
apm-server: kibana: enabled: true host: "https://..." username: "elastic" password: "xxx"
Configuration options
editYou can specify the following output.console
options in the apm-server.yml
config file:
enabled
editThe enabled config is a boolean setting to enable or disable the output. If set to false, the output is disabled.
The default value is true
.
pretty
editIf pretty
is set to true, events written to stdout will be nicely formatted. The default is false.
codec
editOutput codec configuration. If the codec
section is missing, events will be JSON encoded using the pretty
option.
See Change the output codec for more information.
bulk_max_size
editThe maximum number of events to buffer internally during publishing. The default is 2048.
Specifying a larger batch size may add some latency and buffering during publishing. However, for Console output, this setting does not affect how events are published.
Setting bulk_max_size
to values less than or equal to 0 disables the
splitting of batches. When splitting is disabled, the queue decides on the
number of events to be contained in a batch.