README.md in fluent-plugin-hrforecast-0.0.1 vs README.md in fluent-plugin-hrforecast-0.0.2
- old
+ new
@@ -1,16 +1,20 @@
# Fluent::Plugin::Hrforecast
+[![Build Status](https://travis-ci.org/do-aki/fluent-plugin-hrforecast.svg?branch=master)](https://travis-ci.org/do-aki/fluent-plugin-hrforecast)
+
+[![Coverage Status](https://coveralls.io/repos/do-aki/fluent-plugin-hrforecast/badge.png?branch=master)](https://coveralls.io/r/do-aki/fluent-plugin-hrforecast?branch=master)
+
fluentd output plugin for HRForecast
## Overview
Fluented output plugin for sending metrics to [HRForecast](https://github.com/kazeburo/HRForecast).
This plugin code was wittern based on [fluent-plugin-growthforecast](https://github.com/tagomoris/fluent-plugin-growthforecast)
## Configuration
-### Sample2
+### Sample1
Tag is `metrics` and message is `{'field1':10, 'field2':200, 'others':3000}`.
By follow config, send 2 numbers and time specified input plugin to HRForecast.
* send 10 and time to http://hrforecast.local/api/service/section/metrics_field1
* send 200 and time to http://hrforecast.local/api/service/section/metrics_field2
@@ -57,30 +61,43 @@
e.g. `service/section/graph`
You can customize graph_path using `${tag}` and `${key_name}` placeholders.
* __name_keys__ (Either of this or __name_key_pattern__ is required)
+
Specify field names of sending number. Separate by comma.
* __name_key_pattern__ (Either of this or __name_keys__ is required)
+
Specify field names of sending number.
* __datetime_key__ (default: none)
+
Specify field names of sending datetime if you need.
* __datetime_key_format__ (required if specified __datetime_key__)
- Parse format for datetime of field specified datetime_key
+ Parse format for datetime of field specified datetime_key.
+
* __datetime_format__ (default: %Y-%m-%d %H:%M:%S %z)
+
Format of datetime POST parameter.
* __remove_prefix__ (default:none)
+ Remove prefix from tag if specified.
+
* __background_post__ (default:false)
+ Post to HRForecast in background thread, without retries for failures.
+
* __ssl__ (default:false)
+ Use SSL (https) or not.
+
* __verify_ssl__ (default:false)
+
+ Do SSL verification or not.
* __timeout__
* __retry__ (default: true)