Skip to content

Commit

Permalink
Merge pull request fluent#3 from nokute78/doc
Browse files Browse the repository at this point in the history
Doc: fix typo and update execution result
  • Loading branch information
edsiper authored Jul 25, 2016
2 parents b913fdc + fe55db2 commit fbe21d1
Show file tree
Hide file tree
Showing 9 changed files with 27 additions and 47 deletions.
2 changes: 1 addition & 1 deletion getting_started/configuration_file.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The following is an example of an _INPUT_ section:

## Example: collecting CPU metrics

The following configuration file example demonstrate how to collect CPU metrics and flush the results every five seconds to the standard output:
The following configuration file example demonstrates how to collect CPU metrics and flush the results every five seconds to the standard output:

```Python
[SERVICE]
Expand Down
2 changes: 1 addition & 1 deletion input/forward.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Forward

_Forward_ is the protocol used by [Fluent Bit](http://fluentbit.io) and [Fluentd](http://www.fluentd.org) to route messages between peers. This plugin implement the input service to listen for Forward messages.
_Forward_ is the protocol used by [Fluent Bit](http://fluentbit.io) and [Fluentd](http://www.fluentd.org) to route messages between peers. This plugin implements the input service to listen for Forward messages.

## Configuration Parameters

Expand Down
2 changes: 1 addition & 1 deletion input/serial.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ In your main configuration file append the following _Input_ & _Output_ sections

## Emulating Serial Interface on Linux

The following content is some extra information that will allow you to emulate a serial interface on your Linux system, so you can test this _Serial_ input plugin locally in case you don't have such interface in your computer. The following procedure have been tested on Ubuntu 15.04 running a Linux Kernel 4.0.
The following content is some extra information that will allow you to emulate a serial interface on your Linux system, so you can test this _Serial_ input plugin locally in case you don't have such interface in your computer. The following procedure has been tested on Ubuntu 15.04 running a Linux Kernel 4.0.

## Build and install the tty0tty module

Expand Down
29 changes: 10 additions & 19 deletions input/stdin.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ As input data the _stdin_ plugin recognize the following JSON data formats:
2. [ time, { map => val, map => val, map => val } ]
```
A better example to demonstrate how it works will be through a _Bash_ script that generate messages and write them to [Fluent Bit](http://fluentbit.io). Write the following content in a file named _test.sh_:
A better example to demonstrate how it works will be through a _Bash_ script that generates messages and writes them to [Fluent Bit](http://fluentbit.io). Write the following content in a file named _test.sh_:
```bash
#!/bin/sh
Expand All @@ -33,24 +33,15 @@ $ chmod 755 test.sh
Now lets start the script and [Fluent Bit](http://fluentbit.io) in the following way:
```bash
$ ./test.sh | bin/fluent-bit -i stdin -o stdout -V
Fluent Bit v0.3.0
$ ./test.sh | bin/fluent-bit -i stdin -o stdout -v
Fluent-Bit v0.8.3
Copyright (C) Treasure Data

[2015/09/03 17:34:27] [ info] Configuration
flush time : 5 seconds
input plugins : stdin
collectors :
[2015/09/03 17:34:27] [ info] starting engine
[2015/09/03 17:34:27] [debug] in_stdin read() = 21
[2015/09/03 17:34:28] [debug] in_stdin read() = 21
[2015/09/03 17:34:29] [debug] in_stdin read() = 21
[2015/09/03 17:34:30] [debug] in_stdin read() = 21
[2015/09/03 17:34:31] [debug] in_stdin read() = 21
[0] [1441269267, {"key"=>"some value"}]
[1] [1441269268, {"key"=>"some value"}]
[2] [1441269269, {"key"=>"some value"}]
[3] [1441269270, {"key"=>"some value"}]
[4] [1441269271, {"key"=>"some value"}]

[2016/07/24 20:57:28] [ info] starting engine
[2016/07/24 20:57:28] [debug] [router] default match rule stdin.0:stdout.0
[0] (null): [1469361448, {"key"=>"some value"}]
[1] (null): [1469361449, {"key"=>"some value"}]
[2] (null): [1469361450, {"key"=>"some value"}]
[3] (null): [1469361451, {"key"=>"some value"}]
[4] (null): [1469361452, {"key"=>"some value"}]
```
2 changes: 1 addition & 1 deletion input/xbee.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The __xbee__ plugin allows to listen for data through an [XBee Radio](http://www

## Configuration File

[Fluent Bit](http://fluentbit.io) sources distribute an example configuration file for the serial interface and it's located under _conf/serial_input.conf_. The plugin recognize the following setup under a __XBEE__ section:
[Fluent Bit](http://fluentbit.io) sources distribute an example configuration file for the serial interface and it's located under _conf/serial_input.conf_. The plugin recognizes the following setup under a __XBEE__ section:

| Key | Description |
| ----------------|-------------------|
Expand Down
6 changes: 3 additions & 3 deletions installation/build_install.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Build and Install

[Fluent Bit](http://fluentbit.io) uses [CMake](http://cmake.org) as it build system. The suggested procedure to prepare the build system consist on the following steps:
[Fluent Bit](http://fluentbit.io) uses [CMake](http://cmake.org) as it build system. The suggested procedure to prepare the build system consists on the following steps:

## Prepare environment

Expand Down Expand Up @@ -80,7 +80,7 @@ Fluent Bit provides certain options to CMake that can be enabled or disabled whe
| FLB_WITHOUT_EXAMPLES | Do not build examples | No |
| FLB_WITHOUT_SHARED_LIB | Do not build shared library | No |
| FLB_VALGRIND | Enable Valgrind support | No |
| FLB_TRACE | Enable trace mode" | No |
| FLB_TRACE | Enable trace mode | No |
| FLB_MTRACE | Enable mtrace support | No |


Expand Down Expand Up @@ -110,7 +110,7 @@ The _output plugins_ gives the capacity to flush the information to some externa
|------------------|--------------------------------------|----------|
| [FLB_OUT_ES](../output/elasticsearch.md) | Enable [Elastic Search](http://www.elastic.co) output plugin | On |
| [FLB_OUT_FORWARD](../output/forward.md) | Enable [Fluentd](http://www.fluentd.org) output plugin | On |
| [FLB_OUT_NATS](../output/nats.md) | Enable [NATS](http://www.nats.io) output plugin | On |
| [FLB_OUT_NATS](../output/nats.md) | Enable [NATS](http://www.nats.io) output plugin | No |
| [FLB_OUT_STDOUT](../output/stdout.md) | Enable STDOUT output plugin | On |
| [FLB_OUT_HTTP](../output/http.md) | Enable HTTP output plugin | On |
| [FLB_OUT_TD](../output/td.md) | Enable [Treasure Data](http://www.treasuredata.com) output plugin | On |
2 changes: 1 addition & 1 deletion output/elasticsearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ In your main configuration file append the following _Input_ & _Output_ sections

## About Elasticsearch field names

Some input plugins may generate messages where the field names contains dots, since Elasticsearch 2.0 this is not longer allowed, so the current __es__ plugin replace them with an underscore, e.g:
Some input plugins may generate messages where the field names contains dots, since Elasticsearch 2.0 this is not longer allowed, so the current __es__ plugin replaces them with an underscore, e.g:

```
{"cpu0.p_cpu"=>17.000000}
Expand Down
2 changes: 1 addition & 1 deletion output/forward.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Once [Fluentd](http://fluentd.org) is installed, create the following configurat
</match>
```

That configuration file specify that will listen for _TCP_ connections on the port _12225_ through the __forward__ input type. Then for every message with a _fluent\_bit_ __TAG, will print it out to the standard output.
That configuration file specifies that will listen for _TCP_ connections on the port _12225_ through the __forward__ input type. Then for every message with a _fluent\_bit_ __TAG, will print it out to the standard output.

In one terminal launch [Fluentd](http://fluentd.org) specifying the new configuration file created (in_fluent-bit.conf):

Expand Down
27 changes: 8 additions & 19 deletions output/stdout.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,21 @@
The __stdout__ output plugin allows to print to the standard output the data received through the _input_ plugin. Their usage is very simple as follows:

```bash
$ bin/fluent-bit -i cpu -o stdout -V
$ bin/fluent-bit -i cpu -o stdout -v
```

We have specified to gather [CPU](../input/cpu.md) usage metrics and print them out to the standard output in a human readable way:

```bash
Fluent Bit v0.3.0
Fluent-Bit v0.8.3
Copyright (C) Treasure Data

[2015/07/29 15:06:06] [ info] Configuration
flush time : 5 seconds
input plugins : cpu
collectors :
[2015/07/29 15:06:06] [ info] starting engine
[2015/07/29 15:06:06] [debug] [in_cpu] CPU 1.25% (buffer=0)
[2015/07/29 15:06:07] [debug] [in_cpu] CPU 5.75% (buffer=1)
[2015/07/29 15:06:08] [debug] [in_cpu] CPU 9.25% (buffer=2)
[2015/07/29 15:06:09] [debug] [in_cpu] CPU 2.50% (buffer=3)
[2015/07/29 15:06:10] [debug] [in_cpu] CPU 3.25% (buffer=4)
[0] [1438203966, {"cpu"=>1.250000}]
[1] [1438203967, {"cpu"=>5.750000}]
[2] [1438203968, {"cpu"=>9.250000}]
[3] [1438203969, {"cpu"=>2.500000}]
[4] [1438203970, {"cpu"=>3.250000}]
[2015/07/29 15:06:10] [ info] Flush buf 105 bytes

[2016/07/24 21:20:22] [ info] starting engine
[2016/07/24 21:20:22] [debug] [router] default match rule cpu.0:stdout.0
[0] (null): [1469362823, {"cpu_p"=>0.000000, "user_p"=>0.000000, "system_p"=>0.000000, "cpu0.p_cpu"=>0.000000, "cpu0.p_user"=>0.000000, "cpu0.p_system"=>0.000000}]
[1] (null): [1469362824, {"cpu_p"=>2.000000, "user_p"=>2.000000, "system_p"=>0.000000, "cpu0.p_cpu"=>2.000000, "cpu0.p_user"=>2.000000, "cpu0.p_system"=>0.000000}]
[2] (null): [1469362825, {"cpu_p"=>1.000000, "user_p"=>1.000000, "system_p"=>0.000000, "cpu0.p_cpu"=>1.000000, "cpu0.p_user"=>1.000000, "cpu0.p_system"=>0.000000}]
[3] (null): [1469362826, {"cpu_p"=>1.000000, "user_p"=>1.000000, "system_p"=>0.000000, "cpu0.p_cpu"=>1.000000, "cpu0.p_user"=>1.000000, "cpu0.p_system"=>0.000000}]
```

No more, no less, it just works.

0 comments on commit fbe21d1

Please sign in to comment.