Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc: README.md updates #16

Merged
merged 1 commit into from
Jun 9, 2015
Merged

Doc: README.md updates #16

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ $ make
When building _Fluent-Bit_, the following options are available when running __cmake__:

option | value type | description | default
------------|------------|---------------------------------------------|---------
WITH_ALL | bool | Enable all features available | off
WITH_XBEE | bool | Enable XBee support (input) | off
WITH_DEBUG | bool | Include debug symbols when building targets | off
WITHOUT_BIN | bool | Do not build the fluent-bit executable | off
-------------|------------|---------------------------------------------|---------
WITH_ALL | bool | Enable all features available | off
WITH_IN_XBEE | bool | Enable XBee support (input) | off
WITH_DEBUG | bool | Include debug symbols when building targets | off
WITHOUT_BIN | bool | Do not build the fluent-bit executable | off

In order to active one of these features, you need to set a boolean value. As an example if we would like to build _Fluent-Bit_ with _XBee_ support we should do:

```bash
$ cd build/
$ cmake -DWITH_XBEE=1 ..
$ cmake -DWITH_IN_XBEE=1 ..
$ make
```

Expand All @@ -46,11 +46,11 @@ Once the tool have been compiled, a binary file called _Fluent-Bit_ will be foun
| CPU | cpu | gather CPU usage between snapshots of one second. It support multiple cores |
| Memory | mem | usage of system memory |
| Kernel Ring Buffer | kmsg | read Linux Kernel messages, same behavior as the __dmesg__ command line program |
| XBee | xbee | listen for incoming messages over a Xbee device |
| XBee | xbee | listen for incoming messages over a Xbee device |

### Output Plugins

| name | option | description |
| name | option | description |
|--------------------|-------------------------|---------------------------------------------------------------------------------|
| Fluentd | fluentd://host:port | flush content to a [Fluentd](http://fluentd.org) service. On the [Fluentd](http://fluentd.org) side, it requires an __in_forward__.|
| TreasureData | td | flush data collected to [TreasureData](http://treasuredata.com) service (cloud analytics platform) |
Expand Down