output: Elasticsearch: document new Logstash format options

Signed-off-by: Eduardo Silva <[email protected]>
fujimotos · Mar 15, 2017 · 3e9741d · 3e9741d
1 parent 7bcd411
commit 3e9741d
Showing 1 changed file with 8 additions and 3 deletions.
diff --git a/output/elasticsearch.md b/output/elasticsearch.md
@@ -1,15 +1,20 @@
 # Elasticsearch
 
-The __es__ output plugin, allows to flush your records into a [Elastic Search](http://www.elastic.co) instance. The following instructions assumes that you have a fully operational Elasticsearch service running.
+The __es__ output plugin, allows to flush your records into a [Elasticsearch](http://www.elastic.co) database. The following instructions assumes that you have a fully operational Elasticsearch service running in your environment.
 
 ## Configuration Parameters
 
 | Key         | Description          | default           |
 |-------------|----------------------|-------------------|
 | Host        | IP address or hostname of the target Elasticsearch instance | 127.0.0.1 |
 | Port        | TCP port of the target Elasticsearch instance | 9200 |
-| Index       | Elastic index | fluentbit |
-| Type        | Elastic type      | test      |
+| Index       | Index name | fluentbit |
+| Type        | Type name  | flb_type |
+| Logstash\_Format | Enable Logstash format compatibility. This option takes a boolean value: True/False, On/Off | Off |
+| Logstash\_Prefix | When enabling Logstash\_Format, the Index name is composed using a prefix and the date, e.g: If Logstash\_Prefix is equals to 'mydata' your index will become 'mydata-YYYY.MM.DD'. The last string appended belongs to the date when the data is being generated. | logstash |
+| Logstash\_DateFormat | Time format (based on [strftime](http://man7.org/linux/man-pages/man3/strftime.3.html)) to generate the second part of the Index name. | %Y.%m.%d |
+| Time\_Key | When Logstash\_Format is enabled, each record will get a new timestamp field. The Time\_Key property defines the name of that field. | @timestamp |
+| Time\_Key\_Format | When Logstash\_Format is enabled, this property defines the format of the timestamp. | %Y-%m-%dT%H:%M:%S|
 
 > The parameters _index_ and _type_ can be confusing if you are new to Elastic, if you have used a common relational database before, they can be compared to the _database_ and _table_ concepts.