Merge pull request fluent#11 from nokute78/out_flowcounter

output: new FlowCounter output documentation

SUMMARY.md

@@ -35,6 +35,7 @@
     * [XBee Radio](input/xbee.md)
 * [Output Plugins](output/README.md)
     * [Elasticsearch](output/elasticsearch.md)
+    * [FlowCounter](output/flowcounter.md)
     * [Forward](output/forward.md)
     * [HTTP](output/http.md)
     * [InfluxDB](output/influxdb.md)

output/README.md

@@ -4,6 +4,7 @@ The _output plugins_ defines where [Fluent Bit](http://fluentbit.io) should flus
 
 | name                      |  title             | description     |
 |---------------------------|--------------------|-----------------|
+| [flowcounter](flowcounter.md)| FlowCounter     | Count records   |
 | [forward](forward.md)     | Forward  | Fluentd forward protocol. |
 | [http](http.md)           | HTTP     | Flush records to an HTTP end point. |
 | [influxdb](influxdb.md)   | InfluxDB | Flush records to InfluxDB time series database. |

output/flowcounter.md

@@ -0,0 +1,51 @@
+# FlowCounter
+
+_FlowCounter_ is the protocol to count records. The __flowcounter__ output plugin allows to count up records and its size.
+
+## Configuration Parameters
+
+The plugin supports the following configuration parameters:
+
+| Key  | Description | Default | 
+|------|-------------|---------|
+| Unit | The unit of duration. (second/minute/hour/day)| minute |
+
+## Getting Started
+
+You can run the plugin from the command line or through the configuration file:
+
+### Command Line
+
+From the command line you can let Fluent Bit count up a data with the following options:
+
+```bash
+$ fluent-bit -i cpu -o flowcounter
+```
+
+### Configuration File
+
+In your main configuration file append the following Input & Output sections:
+
+```python
+[INPUT]
+    Name cpu
+    Tag  cpu
+
+[OUTPUT]
+    Name flowcounter
+    Match *
+    Unit second
+```
+
+## Testing
+
+Once Fluent Bit is running, you will see the reports in the output interface similar to this:
+
+```bash
+$ fluent-bit -i cpu -o flowcounter  
+Fluent-Bit v0.10.0
+Copyright (C) Treasure Data
+
+[2016/12/23 11:01:20] [ info] [engine] started
+[out_flowcounter] cpu.0:[1482458540, {"counts":60, "bytes":7560, "counts/minute":1, "bytes/minute":126 }]
+```