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

« Step 2: Configure Functionbeat Step 4: Deploy Functionbeat »

› ›

Step 3: Load the index template in Elasticsearch

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 Functionbeat is installed by the Functionbeat packages. If you accept the default configuration in the functionbeat.yml config file, Functionbeat loads the template automatically after successfully connecting to Elasticsearch. If the template already exists, it’s not overwritten unless you configure Functionbeat to do so.

Configure template loading

edit

By default, Functionbeat 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 functionbeat.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 Functionbeat 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

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

Functionbeat uses time series indices, by default, when index lifecycle management is disabled or unsupported. The indices are named functionbeat-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-%{[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.

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

See 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: Configure Functionbeat.

If the host running Functionbeat 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.

mac:

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

brew:

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

linux:

./functionbeat 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 Functionbeat, and run:

PS > .\functionbeat.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 Functionbeat to index data into Elasticsearch, the index may contain old documents. After you load the index template, you can delete the old documents from functionbeat-* to force Kibana to look at the newest documents.

Use this command:

mac:

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

linux:

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

win:

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

This command deletes all indices that match the pattern functionbeat-*. 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 Functionbeat 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:

mac:

./functionbeat export template > functionbeat.template.json

brew:

functionbeat export template > functionbeat.template.json

linux:

./functionbeat export template > functionbeat.template.json

win:

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

To install the template, run:

mac:

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

linux:

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

win:

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

« Step 2: Configure Functionbeat Step 4: Deploy Functionbeat »