A newer version is available. For the latest information, see the current release documentation.

« Load the Elasticsearch index template Index lifecycle management (ILM) »

›

Manually loading template configuration

A connection to Elasticsearch is required to load the index template. If the output is not Elasticsearch, you must load the template manually.

In Elasticsearch, index templates are used to define settings and mappings that determine how fields should be analyzed.

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

Configure template loading

edit

By default, APM Server automatically loads the recommended template file, fields.yml, if the Elasticsearch output is enabled. If you want to use the default index template, no additional configuration is required. Otherwise, you can change the defaults in the apm-server.yml config file to:

Load a different template
```
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 APM Server to do so.
Overwrite an existing template
```
setup.template.overwrite: true
```
Disable automatic template loading
```
setup.template.enabled: false
```
If you disable automatic template loading, you need to load the template manually.
Change the index name

APM Server uses time series indices, by default, when index lifecycle management is disabled or unsupported. The indices are named apm-server-7.6.2-yyyy.MM.dd, where yyyy.MM.dd is the date when the events were indexed. To use a different name, you 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-%{[observer.version]}-%{+yyyy.MM.dd}"
setup.template.name: "customname"
setup.template.pattern: "customname-*"
```

Remember to change the index name when you load dashboards via the Kibana UI.

See Load the Elasticsearch index template for the full list of configuration options.

Load the template manually

edit

To load the 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 Step 2: Set up and configure.

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

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

deb and rpm:

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

mac:

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

brew:

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

linux:

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

docker:

docker run docker.elastic.co/apm/apm-server:7.6.2 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 APM Server, and run:

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

Force Kibana to look at newest documents

edit

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

Use this command:

deb and rpm:

curl -XDELETE 'http://localhost:9200/apm-server-*'

mac:

curl -XDELETE 'http://localhost:9200/apm-server-*'

linux:

curl -XDELETE 'http://localhost:9200/apm-server-*'

win:

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

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

Load the template manually (alternate method)

edit

If the host running APM Server 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:

apm-server export template > apm-server.template.json

mac:

./apm-server export template > apm-server.template.json

brew:

apm-server export template > apm-server.template.json

linux:

./apm-server export template > apm-server.template.json

win:

PS > .\apm-server.exe export template --es.version 7.6.2 | Out-File -Encoding UTF8 apm-server.template.json

To install the template, run:

deb and rpm:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/apm-server-7.6.2 -d@apm-server.template.json

mac:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/apm-server-7.6.2 -d@apm-server.template.json

linux:

curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/apm-server-7.6.2 -d@apm-server.template.json

win:

PS > Invoke-RestMethod -Method Put -ContentType "application/json" -InFile apm-server.template.json -Uri http://localhost:9200/_template/apm-server-7.6.2

« Load the Elasticsearch index template Index lifecycle management (ILM) »