WARNING: Version 6.2 of Winlogbeat has passed its EOL date.
This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.
In Elasticsearch, index templates are used to define settings and mappings that determine how fields should be analyzed.
The recommended index template file for Winlogbeat is installed by the
Winlogbeat packages. If you accept the default configuration in the
winlogbeat.yml config file, Winlogbeat loads the template automatically
after successfully connecting to Elasticsearch. If the template already exists,
it’s not overwritten unless you configure Winlogbeat to do so.
You can disable automatic template loading, or load your own template, by configuring template loading options in the Winlogbeat configuration file.
You can also set options to change the name of the index and index template.
A connection to Elasticsearch is required to load the index template. If the output is Logstash, you must load the template manually.
For more information, see:
By default, Winlogbeat automatically loads the recommended template file,
fields.yml, if the Elasticsearch output is enabled. You can change the
defaults in the
winlogbeat.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 Winlogbeat to do so.
Overwrite an existing template
Disable automatic template loading
If you disable automatic template loading, you need to load the template manually.
Change the index name
By default, Winlogbeat writes events to indices named
yyyy.MM.ddis the date when the events were indexed. To use a different name, you set the
indexoption 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.patternoptions to match the new name. For example:
If you plan to set up the Kibana dashboards, also set this option to overwrite the index name defined in the dashboards and index pattern.
See Load the Elasticsearch index template for the full list of configuration options.
To load the template manually, run the
setup command. A
connection to Elasticsearch is required.
If Logstash output is enabled, you need
to temporarily disable the Logstash output and enable Elasticsearch by using the
-E option. The examples here assume that Logstash output is enabled. You can
-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 Winlogbeat.
If the host running Winlogbeat 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.
Open a PowerShell prompt as an Administrator (right-click the PowerShell icon and select Run As Administrator). If you are running Windows XP, you may need to download and install PowerShell.
From the PowerShell prompt, change to the directory where you installed Winlogbeat, and run:
PS > .\winlogbeat setup --template -E output.logstash.enabled=false -E 'output.elasticsearch.hosts=["localhost:9200"]'
If you’ve already used Winlogbeat to index data into Elasticsearch,
the index may contain old documents. After you load the index template,
you can delete the old documents from
winlogbeat-* to force Kibana to look
at the newest documents. Use this command:
deb, rpm, and mac:
curl -XDELETE 'http://localhost:9200/winlogbeat-*'
PS > Invoke-RestMethod -Method Delete "http://localhost:9200/winlogbeat-*"
This command deletes all indices that match the pattern
Before running this command, make sure you want to delete all indices that match
If the host running Winlogbeat 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.
Export the index template:
PS> .\winlogbeat.exe export template --es.version 6.2.4 | Out-File -Encoding UTF8 winlogbeat.template.json
Install the template:
deb, rpm, and mac:
curl -XPUT -H 'Content-Type: application/json' http://localhost:9200/_template/winlogbeat-6.2.4 -email@example.com
PS > Invoke-RestMethod -Method Put -ContentType "application/json" -InFile winlogbeat.template.json -Uri http://localhost:9200/_template/winlogbeat-6.2.4