Skip to content

Commit

Permalink
[7.1][DOCS] Backport: Add pointer to ILM docs from index setting (#13035
Browse files Browse the repository at this point in the history
) (#13154)

* [DOCS] Add pointer to ILM docs from index setting (#13035)

* Remove line added during merge
  • Loading branch information
dedemorton authored Aug 6, 2019
1 parent 5ea5ba4 commit ab4eff5
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion libbeat/docs/outputconfig.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ for more information about the environment variables.
===== `index`

ifndef::apm-server[]
The index name to write events to. The default is
The index name to write events to when you're using daily indices. The default is
+"{beatname_lc}-%\{[{beat_version_key}]\}-%\{+yyyy.MM.dd\}"+ (for example,
+"{beatname_lc}-{version}-{localdate}"+). If you change this setting, you also
need to configure the `setup.template.name` and `setup.template.pattern` options
Expand Down Expand Up @@ -247,6 +247,12 @@ dashboards, you also need to set the `setup.dashboards.index` option (see
<<configuration-dashboards>>).
endif::no_dashboards[]

ifndef::no_ilm[]
The `index` setting is ignored when index lifecycle management is enabled. If
you’re sending events to a cluster that supports index lifecycle management, see
<<ilm>> to learn how to change the index name.
endif::no_ilm[]

You can set the index dynamically by using a format string to access any event
field. For example, this configuration uses a custom field, `fields.log_type`,
to set the index:
Expand Down

0 comments on commit ab4eff5

Please sign in to comment.