﻿---
title: Configure Heartbeat monitors
description: To configure Heartbeat define a set of monitors to check your remote hosts. Specify monitors either directly inside the heartbeat.yml config file, or...
url: https://www.elastic.co/elastic/docs-builder/docs/2666/reference/beats/heartbeat/configuration-heartbeat-options
products:
  - Beats
  - Heartbeat
applies_to:
  - Elastic Stack: Generally available
---

# Configure Heartbeat monitors
To configure Heartbeat define a set of `monitors` to check your remote hosts. Specify monitors either directly inside the `heartbeat.yml` config file, or in external dynamically loaded files located in the directory referenced by `heartbeat.config.monitors.path`. One advantage of using external files is that these can be automatically reloaded without stopping the Heartbeat process.
Each `monitor` item is an entry in a yaml list, and so begins with a dash (-). You can define the type of monitor to use, the hosts to check, and other optional settings that control Heartbeat behavior.
The following example configures three monitors checking via the `icmp`, `tcp`, and `http` protocols directly inside the `heartbeat.yml` file, and demonstrates how to use TCP Echo and HTTP response verification:
```yaml
# heartbeat.yml
heartbeat.monitors:
- type: icmp
  id: ping-myhost
  name: My Host Ping
  hosts: ["myhost"]
  schedule: '*/5 * * * * * *'
- type: tcp
  id: myhost-tcp-echo
  name: My Host TCP Echo
  hosts: ["myhost:777"] 
  check.send: "Check"
  check.receive: "Check"
  schedule: '@every 5s'
- type: http
  id: service-status
  name: Service Status
  service.name: my-apm-service-name
  hosts: ["http://localhost:80/service/status"]
  check.response.status: [200]
  schedule: '@every 5s'
heartbeat.scheduler:
  limit: 10
```

Using the `heartbeat.yml` configuration file is convenient, but has two drawbacks: it can become hard to manage with large numbers of monitors, and it will not reload heartbeat automatically when its contents changes.
Define monitors via the `heartbeat.config.monitors` to prevent those issues from happening to you. To do so you would instead have your `heartbeat.yml` file contain the following:
```yaml
# heartbeat.yml
heartbeat.config.monitors:
  # Directory + glob pattern to search for configuration files
  path: /path/to/my/monitors.d/*.yml
  # If enabled, heartbeat will periodically check the config.monitors path for changes
  reload.enabled: true
  # How often to check for changes
  reload.period: 1s
```

Then, define one or more files in the directory pointed to by `heartbeat.config.monitors.path`. You may specify multiple monitors in a given file if you like. The contents of these files is monitor definitions only, e.g. what is normally under the `heartbeat.monitors` section of `heartbeat.yml`. See below for an example
```yaml
# /path/to/my/monitors.d/localhost_service_check.yml
- type: http
  id: service-status
  name: Service Status
  hosts: ["http://localhost:80/service/status"]
  check.response.status: [200]
  schedule: '@every 5s'
```


## Monitor types

You can configure Heartbeat to use the following monitor types:
<definitions>
  <definition term="icmp">
    Uses an ICMP (v4 and v6) Echo Request to ping the configured hosts. Requires special permissions or root access.
  </definition>
  <definition term="tcp">
    Connects via TCP and optionally verifies the endpoint by sending and/or receiving a custom payload.
  </definition>
  <definition term="http">
    Connects via HTTP and optionally verifies that the host returns the expected response. Will use `Elastic-Heartbeat` as the user agent product.
  </definition>
</definitions>

The `tcp` and `http` monitor types both support SSL/TLS and some proxy settings.
<note>
  **Looking for browser monitor options?**  Heartbeat browser checks are in beta and will never be made generally available.If you want to set up browser checks, we highly recommend using Synthetics via [Projects](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2666/solutions/observability/synthetics/create-monitors-with-projects) or the [Synthetics app in Kibana](https://docs-v3-preview.elastic.dev/elastic/docs-builder/docs/2666/solutions/observability/synthetics/create-monitors-ui) to create and manage browser monitors.If you need to refer to how beta Heartbeat browser checks were set up previously, refer to the [Browser options documentation for 8.7](https://www.elastic.co/guide/en/beats/heartbeat/8.7/monitor-browser-options.html).
</note>