Changing the index name for winlogbeat sent to elasticsearch

Elastic Stack Beats
1

Hi All,

Just trying to change the name of the winlogbeat index to something more meaningful. Currently I get the following error:

Exiting: setup.template.name and setup.template.pattern have to be set if index name is modified

My winlogbeat.yml output section is:

output.elasticsearch:

Array of hosts to connect to.

hosts: ["x.x.x:9200"]

Enabled ilm (beta) to use index lifecycle management instead daily indices.

setup.template.overwrite: false
setup.template.enabled: false
index: "winlogbeat-%{+YYYY.MM}"
output.elasticsearch.index: "winlogbeat-%{+yyyy.MM}"

2

Did you set those as well?

3

I believe I defined it but what should it be set too?

setup.template.name: ?
setup.template.pattern: ?

4

Show us what you have there now. Also please use the </> button to format your pasted config, it makes it heaps easier to read :slight_smile:

5

Just found this article - https://www.elastic.co/guide/en/beats/winlogbeat/master/configuration-template.html

I might try setting the following items

setup.template.name: "winlogbeat"
setup.template.pattern: "winlogbeat-*"

I don't have access at the moment but I will try later this afternoon and update you.

6 
###################### Winlogbeat Configuration Example ##########################

# This file is an example configuration file highlighting only the most common
# options. The winlogbeat.reference.yml file from the same directory contains all the
# supported options with more comments. You can use it as a reference.
#
# You can find the full configuration reference here:
# https://www.elastic.co/guide/en/beats/winlogbeat/index.html

#======================= Winlogbeat specific options ==========================

# event_logs specifies a list of event logs to monitor as well as any
# accompanying options. The YAML data type of event_logs is a list of
# dictionaries.
#
# The supported keys are name (required), tags, fields, fields_under_root,
# forwarded, ignore_older, level, event_id, provider, and include_xml. Please
# visit the documentation for the complete details of each option.
# https://go.es.io/WinlogbeatConfig
winlogbeat.event_logs:
  - name: Application
    ignore_older: 72h
  - name: Security
    ignore_older: 72h
  - name: System
    ignore_older: 72h

#==================== Elasticsearch template setting ==========================

setup.template.settings:
  index.number_of_shards: 3
  #index.codec: best_compression
  #_source.enabled: false

#================================ General =====================================

# The name of the shipper that publishes the network data. It can be used to group
# all the transactions sent by a single shipper in the web interface.
#name:

# The tags of the shipper are included in their own field with each
# transaction published.
#tags: ["service-X", "web-tier"]

# Optional fields that you can specify to add additional information to the
# output.
#fields:
#  env: staging


#============================== Dashboards =====================================
# These settings control loading the sample dashboards to the Kibana index. Loading
# the dashboards is disabled by default and can be enabled either by setting the
# options here, or by using the `-setup` CLI flag or the `setup` command.
#setup.dashboards.enabled: false

# The URL from where to download the dashboards archive. By default this URL
# has a value which is computed based on the Beat name and version. For released
# versions, this URL points to the dashboard archive on the artifacts.elastic.co
# website.
#setup.dashboards.url:

#============================== Kibana =====================================

# Starting with Beats version 6.0.0, the dashboards are loaded via the Kibana API.
# This requires a Kibana endpoint configuration.
setup.kibana:

  # Kibana Host
  # Scheme and port can be left out and will be set to the default (http and 5601)
  # In case you specify and additional path, the scheme is required: http://localhost:5601/path
  # IPv6 addresses should always be defined as: https://[2001:db8::1]:5601
 host: "kibana.x.info:5601"

  # Kibana Space ID
  # ID of the Kibana Space into which the dashboards should be loaded. By default,
  # the Default Space will be used.
  #space.id:

#============================= Elastic Cloud ==================================

# These settings simplify using winlogbeat with the Elastic Cloud (https://cloud.elastic.co/).

# The cloud.id setting overwrites the `output.elasticsearch.hosts` and
# `setup.kibana.host` options.
# You can find the `cloud.id` in the Elastic Cloud web UI.
#cloud.id:

# The cloud.auth setting overwrites the `output.elasticsearch.username` and
# `output.elasticsearch.password` settings. The format is `<user>:<pass>`.
#cloud.auth:

#================================ Outputs =====================================

# Configure what output to use when sending the data collected by the beat.

#-------------------------- Elasticsearch output ------------------------------
output.elasticsearch:
  # Array of hosts to connect to.
  hosts: ["elastic.x.info:9200"]
 # Enabled ilm (beta) to use index lifecycle management instead daily indices.
index: "winlogbeat-%{+yyyy.MM}"
setup.template.name: "winlogbeat"
setup.template.pattern: "winlogbeat*"
# #ilm.enabled: false
  

  # Optional protocol and basic auth credentials.
  #protocol: "https"
  #username: "elastic"
  #password: "changeme"

#----------------------------- Logstash output --------------------------------
#output.logstash:
  # The Logstash hosts
  #hosts: ["localhost:5044"]

  # Optional SSL. By default is off.
  # List of root certificates for HTTPS server verifications
  #ssl.certificate_authorities: ["/etc/pki/root/ca.pem"]

  # Certificate for SSL client authentication
  #ssl.certificate: "/etc/pki/client/cert.pem"

  # Client Certificate Key
  #ssl.key: "/etc/pki/client/cert.key"
#================================ Processors =====================================

# Configure processors to enhance or manipulate events generated by the beat.

processors:
  - add_host_metadata: ~
  - add_cloud_metadata: ~

#================================ Logging =====================================

# Sets log level. The default log level is info.
# Available log levels are: error, warning, info, debug
#logging.level: debug

# At debug level, you can selectively enable logging only for some components.
# To enable all selectors use ["*"]. Examples of other selectors are "beat",
# "publish", "service".
#logging.selectors: ["*"]

#============================== Xpack Monitoring ===============================
# winlogbeat can export internal metrics to a central Elasticsearch monitoring
# cluster.  This requires xpack monitoring to be enabled in Elasticsearch.  The
# reporting is disabled by default.

# Set to true to enable the monitoring reporter.
xpack.monitoring.enabled: true

# Uncomment to send the metrics to Elasticsearch. Most settings from the
# Elasticsearch output are accepted here as well. Any setting that is not set is
# automatically inherited from the Elasticsearch output configuration, so if you
# have the Elasticsearch output configured, you can simply uncomment the
# following line.
#xpack.monitoring.elasticsearch:
7

Hi,

You can change names and length of the index rotation as bellow. Setting up the template and creation of the index has to be in different section.

setup.template:
    name:    'my-winlog-%{[beat.version]}'
    pattern: 'my-winlog-%{[beat.version]}-*'
    settings:
      index.number_of_shards: 3
      index.number_of_replicas: 1
      index.codec: best_compression

output.elasticsearch:
    hosts:
      - '{{ es_url }}'
    username: '{{ beat_username }}'
    password: '{{ beat_password }}'
    index: 'my-winlog-%{[beat.version]}-%{+yyyy.MM}'
1 Like
8

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.