A newer version is available. For the latest information, see the current release documentation.
Elastic Docs › ›Configuring APM Server
« Specify SSL settings Manually loading template configuration »

Load the Elasticsearch index templateedit

The setup.template section of the apm-server.yml config file specifies the index template to use for setting mappings in Elasticsearch. If template loading is enabled (the default), APM Server loads the index template automatically after successfully connecting to Elasticsearch.

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

You can adjust the following settings to load your own template or overwrite an existing one.

setup.template.enabled
Set to false to disable template loading. If set this to false, you must load the template manually.
setup.template.name
The name of the template. The default is apm-server. The APM Server version is always appended to the given name, so the final name is apm-server-%{[observer.version]}.
setup.template.pattern

The template pattern to apply to the default index settings. The default pattern is apm-*. The APM Server version is always included in the pattern, so the final pattern is apm-%{[observer.version]}-*. The wildcard character -* is used to match all daily indices.

Example:

setup.template.name: "apm-server"
setup.template.pattern: "apm-*"
setup.template.fields
The path to the YAML file describing the fields. The default is fields.yml. If a relative path is set, it is considered relative to the config path. See the Directory layout section for details.
setup.template.overwrite
A boolean that specifies whether to overwrite the existing template. The default is false.
setup.template.settings

A dictionary of settings to place into the settings.index dictionary of the Elasticsearch template. For more details about the available Elasticsearch mapping options, please see the Elasticsearch mapping reference.

Example:

setup.template.name: "apm-server"
setup.template.fields: "fields.yml"
setup.template.overwrite: false
setup.template.settings:
  index.number_of_shards: 1
  index.number_of_replicas: 1

If you want to use cross-cluster replication to replicate APM Server indices to another cluster, you will need to add additional template settings to enable soft deletes on the underlying indices.

setup.template.settings._source

A dictionary of settings for the _source field. For the available settings, please see the Elasticsearch reference.

Example:

setup.template.name: "apm-server"
setup.template.fields: "fields.yml"
setup.template.overwrite: false
setup.template.settings:
  _source.enabled: false
« Specify SSL settings Manually loading template configuration »