README

Author: ecwws

README.md

@@ -1,2 +1,31 @@
 # fluent-plugin-elasticsearch-timestamp-check
 Fluent plugin to ensure @timestamp is in correct format for elasticsearch
+
+## Install
+
+```bash
+gem install fluent-plugin-elasticsearch-timestamp-check
+```
+
+## Description
+
+The purpose of this filter is to make sure the @timestamp field exists in the
+record which is necessary for the record to be indexed properly by
+elasticsearch.
+
+* If *@timestamp* field already exists, it will ensure the format is correct
+  by parse and convert to format '%Y-%m-%dT%H:%M:%S%z'.
+
+* If a field named *timestamp* exists, it will parse that field and conver it to
+  format '%Y-%m-%dT%H:%M:%S%z' then store it in *@timestamp* field.
+
+* If neither of the above field exists, it will insert current time in
+  '%Y-%m-%dT%H:%M:%S%z' format as the *@timestamp* field.
+
+## Usage
+
+```
+<filter **>
+  type elasticsearch_timestamp_check
+</filter>
+```