Skip to content

Commit

Permalink
Merge pull request #1043 from sparrowt/patch-1
Browse files Browse the repository at this point in the history
Clarify README docs for template_name and templates
  • Loading branch information
cosmo0920 authored Jan 23, 2024
2 parents 96e1ec4 + ca32595 commit 0d24bb6
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -527,7 +527,7 @@ into same document with data1 as wanted and duplicated document is avoided.

### template_name

The name of the template to define. If a template by the name given is already present, it will be left unchanged, unless [template_overwrite](#template_overwrite) is set, in which case the template will be updated.
The name of the index template to create on fluentd startup. If a template by the name given is already present, it will be left unchanged, unless [template_overwrite](#template_overwrite) is set, in which case the template will be updated.

This parameter along with template_file allow the plugin to behave similarly to Logstash (it installs a template at creation time) so that raw records are available. See [https://github.com/uken/fluent-plugin-elasticsearch/issues/33](https://github.com/uken/fluent-plugin-elasticsearch/issues/33).

Expand All @@ -541,7 +541,7 @@ The path to the file containing the template to install.

### templates

Specify index templates in form of hash. Can contain multiple templates.
Specify index templates (to be created on startup) in the form of a hash (accepts JSON dict). Can contain multiple templates.

```
templates { "template_name_1": "path_to_template_1_file", "template_name_2": "path_to_template_2_file"}
Expand Down

0 comments on commit 0d24bb6

Please sign in to comment.