Load the Elasticsearch index template

Elasticsearch uses index templates to define:

The recommended index template file for Heartbeat is installed by the Heartbeat packages. If you accept the default configuration in the heartbeat.yml config file, Heartbeat loads the template automatically after successfully connecting to Elasticsearch. If the template already exists, it’s not overwritten unless you configure Heartbeat to do so.

This page shows how to change the default template loading behavior to:

For a full list of template setup options, see Elasticsearch index template.

To load your own index template, set the following options:

setup.template.name: "your_template_name"
setup.template.fields: "path/to/fields.yml"

If the template already exists, it’s not overwritten unless you configure Heartbeat to do so.

You can load templates for both data streams and indices.

To overwrite a template that’s already loaded into Elasticsearch, set:

setup.template.overwrite: true

You may want to disable automatic template loading if you’re using an output other than Elasticsearch and need to load the template manually. To disable automatic template loading, set:

setup.template.enabled: false

If you disable automatic template loading, you must load the index template manually.

To load the index template manually, run the setup command. A connection to Elasticsearch is required. If another output is enabled, you need to temporarily disable that output and enable Elasticsearch by using the -E option. The examples here assume that Logstash output is enabled. You can omit the -E flags if Elasticsearch output is already enabled.

If you are connecting to a secured Elasticsearch cluster, make sure you’ve configured credentials as described in the Quick start: installation and configuration.

If the host running Heartbeat does not have direct connectivity to Elasticsearch, see Load the index template manually (alternate method).

To load the template, use the appropriate command for your system.

deb and rpm:

heartbeat setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

mac:

./heartbeat setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

linux:

./heartbeat setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

docker:

docker run --rm docker.elastic.co/beats/heartbeat:8.16.0 setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

win:

Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator).

From the PowerShell prompt, change to the directory where you installed Heartbeat, and run:

PS > .\heartbeat.exe setup --index-management -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'

If you’ve already used Heartbeat to index data into Elasticsearch, the index may contain old documents. After you load the index template, you can delete the old documents from heartbeat-* to force Kibana to look at the newest documents.

Use this command:

deb and rpm:

curl -XDELETE 'http://localhost:9200/heartbeat-*'

mac:

curl -XDELETE 'http://localhost:9200/heartbeat-*'

linux:

curl -XDELETE 'http://localhost:9200/heartbeat-*'

win:

PS > Invoke-RestMethod -Method Delete "http://localhost:9200/heartbeat-*"

This command deletes all indices that match the pattern heartbeat. Before running this command, make sure you want to delete all indices that match the pattern.

If the host running Heartbeat does not have direct connectivity to Elasticsearch, you can export the index template to a file, move it to a machine that does have connectivity, and then install the template manually.

To export the index template, run:

deb and rpm:

heartbeat export template > heartbeat.template.json

mac:

./heartbeat export template > heartbeat.template.json

linux:

./heartbeat export template > heartbeat.template.json

win:

PS > .\heartbeat.exe export template --es.version 8.16.0 | Out-File -Encoding UTF8 heartbeat.template.json

To install the template, run:

deb and rpm:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_index_template/heartbeat-8.16.0 -d@heartbeat.template.json

mac:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_index_template/heartbeat-8.16.0 -d@heartbeat.template.json

linux:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_index_template/heartbeat-8.16.0 -d@heartbeat.template.json

win:

PS > Invoke-RestMethod -Method Put -ContentType "application/json" -InFile heartbeat.template.json -Uri http://localhost:9200/_index_template/heartbeat-8.16.0

Once you have loaded the index template, load the data stream as well. If you do not load it, you have to give the publisher user manage permission on heartbeat-8.16.0 index.

deb and rpm:

curl -XPUT http://localhost:9200/_data_stream/heartbeat-8.16.0

mac:

curl -XPUT http://localhost:9200/_data_stream/heartbeat-8.16.0

linux:

curl -XPUT http://localhost:9200/_data_stream/heartbeat-8.16.0

win:

PS > Invoke-RestMethod -Method Put -Uri http://localhost:9200/_data_stream/heartbeat-8.16.0