Monitoring configuration options
editMonitoring configuration options
editYou can specify the following options in the xpack.monitoring section of the
apm-server.yml config file:
enabled
editThe enabled config is a boolean setting to enable or disable X-Pack monitoring.
If set to true, monitoring is enabled.
The default value is false.
elasticsearch
editThe Elasticsearch instances that you want to ship your APM Server metrics to. This configuration option contains the following fields:
bulk_max_size
editThe maximum number of metrics to bulk in a single Elasticsearch bulk API index request.
The default is 50. For more information, see Elasticsearch.
backoff.init
editThe number of seconds to wait before trying to reconnect to Elasticsearch after
a network error. After waiting backoff.init seconds, APM Server tries to
reconnect. If the attempt fails, the backoff timer is increased exponentially up
to backoff.max. After a successful connection, the backoff timer is reset. The
default is 1s.
backoff.max
editThe maximum number of seconds to wait before attempting to connect to Elasticsearch after a network error. The default is 60s.
compression_level
editThe gzip compression level. Setting this value to 0 disables compression. The
compression level must be in the range of 1 (best speed) to 9 (best
compression). The default value is 0. Increasing the compression level
reduces the network usage but increases the CPU usage.
headers
editCustom HTTP headers to add to each request. For more information, see Elasticsearch.
hosts
editThe list of Elasticsearch nodes to connect to. Monitoring metrics are distributed to these nodes in round robin order. For more information, see Elasticsearch.
max_retries
editThe number of times to retry sending the monitoring metrics after a failure.
After the specified number of retries, the metrics are typically dropped. The
default value is 3. For more information, see Elasticsearch.
parameters
editDictionary of HTTP parameters to pass within the url with index operations.
password
editThe password that APM Server uses to authenticate with the Elasticsearch instances for shipping monitoring data.
metrics.period
editThe time interval (in seconds) when metrics are sent to the Elasticsearch cluster. A new snapshot of APM Server metrics is generated and scheduled for publishing each period. The default value is 10 * time.Second.
state.period
editThe time interval (in seconds) when state information are sent to the Elasticsearch cluster. A new snapshot of APM Server state is generated and scheduled for publishing each period. The default value is 60 * time.Second.
protocol
editThe name of the protocol to use when connecting to the Elasticsearch cluster. The options
are: http or https. The default is http. If you specify a URL for hosts,
however, the value of protocol is overridden by the scheme you specify in the URL.
proxy_url
editThe URL of the proxy to use when connecting to the Elasticsearch cluster. For more information, see Elasticsearch.
timeout
editThe HTTP request timeout in seconds for the Elasticsearch request. The default is 90.
ssl
editConfiguration options for Transport Layer Security (TLS) or Secure Sockets Layer
(SSL) parameters like the certificate authority (CA) to use for HTTPS-based
connections. If the ssl section is missing, the host CAs are used for
HTTPS connections to Elasticsearch. For more information, see Specify SSL settings.
username
editThe user ID that APM Server uses to authenticate with the Elasticsearch instances for shipping monitoring data.