A newer version is available. For the latest information, see the current release documentation.
« Load the Elasticsearch index template Load Kibana dashboards »
Elastic Docs ›Metricbeat Reference [7.17] ›How to guides

Change the index name

edit

Change the index name

edit

If you’re sending events to a cluster that supports index lifecycle management, you need to change the index name in the ILM policy. See Index lifecycle management (ILM) to learn how to change it.

Metricbeat uses time series indices, by default, when index lifecycle management is disabled or unsupported. The indices are named metricbeat-7.17.25-yyyy.MM.dd, where yyyy.MM.dd is the date when the events were indexed. To use a different name, set the index option in the Elasticsearch output. The value that you specify should include the root name of the index plus version and date information. You also need to configure the setup.template.name and setup.template.pattern options to match the new name. For example:

output.elasticsearch.index: "customname-%{[agent.version]}-%{+yyyy.MM.dd}"
setup.template.name: "customname"
setup.template.pattern: "customname-*"

If index lifecycle management is enabled (which is typically the default), setup.template.name and setup.template.pattern are ignored.

If you’re using pre-built Kibana dashboards, also set the setup.dashboards.index option. For example:

setup.dashboards.index: "customname-*"

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

« Load the Elasticsearch index template Load Kibana dashboards »