Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 1095475

Browse files
committedMar 27, 2017
output: file: add documentation for out_file
Signed-off-by: Takahiro YAMASHITA <nokute78@gmail.com>
1 parent 0bc82cf commit 1095475

File tree

3 files changed

+41
-1
lines changed

3 files changed

+41
-1
lines changed
 

‎SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
* [Kubernetes](filter/kubernetes.md)
5050
* [Output Plugins](output/README.md)
5151
* [Elasticsearch](output/elasticsearch.md)
52+
* [File](output/file.md)
5253
* [FlowCounter](output/flowcounter.md)
5354
* [Forward](output/forward.md)
5455
* [HTTP](output/http.md)

‎output/README.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ The _output plugins_ defines where [Fluent Bit](http://fluentbit.io) should flus
44

55
| name | title | description |
66
|---------------------------|--------------------|-----------------|
7-
| [flowcounter](flowcounter.md)| FlowCounter | Count records |
7+
| [file](file.md) | File | flush records to a file. |
8+
| [flowcounter](flowcounter.md)| FlowCounter | Count records. |
89
| [forward](forward.md) | Forward | Fluentd forward protocol. |
910
| [http](http.md) | HTTP | Flush records to an HTTP end point. |
1011
| [influxdb](influxdb.md) | InfluxDB | Flush records to InfluxDB time series database. |

‎output/file.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# File
2+
3+
The __file__ output plugin allows to write the data received through the _input_ plugin to file.
4+
5+
## Configuration Parameters
6+
7+
The plugin supports the following configuration parameters:
8+
9+
| Key | Description |
10+
|------|-------------|
11+
| Path | File path to output. If not set, the filename will be tag name.|
12+
13+
## Getting Started
14+
15+
You can run the plugin from the command line or through the configuration file:
16+
17+
### Command Line
18+
19+
From the command line you can let Fluent Bit count up a data with the following options:
20+
21+
```bash
22+
$ fluent-bit -i cpu -o file -p path=output.txt
23+
```
24+
25+
### Configuration File
26+
27+
In your main configuration file append the following Input & Output sections:
28+
29+
```python
30+
[INPUT]
31+
Name cpu
32+
Tag cpu
33+
34+
[OUTPUT]
35+
Name file
36+
Match *
37+
Path output.txt
38+
```

0 commit comments

Comments
 (0)