Configure Heartbeat [configuring-howto-heartbeat]

::::{tip} To get started quickly, read Quick start: installation and configuration. ::::

To configure Heartbeat, edit the configuration file. The default configuration file is called heartbeat.yml. The location of the file varies by platform. To locate the file, see Directory layout.

There’s also a full example configuration file called heartbeat.reference.yml that shows all non-deprecated options.

::::{tip} See the Config File Format for more about the structure of the config file. ::::

The following topics describe how to configure Heartbeat:

• Monitors
• Task scheduler
• General settings
• Project paths
• Output
• SSL
• Index lifecycle management (ILM)
• Elasticsearch index template
• Processors
• Autodiscover
• Internal queue
• Logging
• HTTP endpoint
• Regular expression support
• Instrumentation
• Feature flags
• heartbeat.reference.yml