IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Use internal collection to send monitoring data Use Metricbeat to send monitoring data »
Elastic Docs ›Heartbeat Reference [7.5] ›Monitoring Heartbeat ›Use internal collection to send monitoring data

Settings for internal collection

edit

Settings for internal collection

edit

Use the following settings to configure internal collection when you are not using Metricbeat to collect monitoring data.

You specify these settings in the X-Pack monitoring section of the heartbeat.yml config file:

monitoring.enabled

edit

The monitoring.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.

monitoring.elasticsearch

edit

The Elasticsearch instances that you want to ship your Heartbeat metrics to. This configuration option contains the following fields:

bulk_max_size

edit

The 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

edit

The number of seconds to wait before trying to reconnect to Elasticsearch after a network error. After waiting backoff.init seconds, Heartbeat 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

edit

The maximum number of seconds to wait before attempting to connect to Elasticsearch after a network error. The default is 60s.

compression_level

edit

The 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

edit

Custom HTTP headers to add to each request. For more information, see Elasticsearch.

hosts

edit

The 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

edit

The 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

edit

Dictionary of HTTP parameters to pass within the url with index operations.

password

edit

The password that Heartbeat uses to authenticate with the Elasticsearch instances for shipping monitoring data.

metrics.period

edit

The time interval (in seconds) when metrics are sent to the Elasticsearch cluster. A new snapshot of Heartbeat metrics is generated and scheduled for publishing each period. The default value is 10 * time.Second.

state.period

edit

The time interval (in seconds) when state information are sent to the Elasticsearch cluster. A new snapshot of Heartbeat state is generated and scheduled for publishing each period. The default value is 60 * time.Second.

protocol

edit

The 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

edit

The URL of the proxy to use when connecting to the Elasticsearch cluster. For more information, see Elasticsearch.

timeout

edit

The HTTP request timeout in seconds for the Elasticsearch request. The default is 90.

ssl

edit

Configuration 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

edit

The user ID that Heartbeat uses to authenticate with the Elasticsearch instances for shipping monitoring data.

« Use internal collection to send monitoring data Use Metricbeat to send monitoring data »