Skip to content

Commit f42df01

Browse files
authored
golang-output-plugin: add configuration file section (fluent#886)
Signed-off-by: Takahiro Yamashita <nokute78@gmail.com> Signed-off-by: Takahiro Yamashita <nokute78@gmail.com>
1 parent 374db58 commit f42df01

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

development/golang-output-plugins.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,54 @@ $ ldd out_gstdout.so
9494
$ bin/fluent-bit -e /path/to/out_gstdout.so -i cpu -o gstdout
9595
```
9696

97+
## Configuration file
98+
99+
Fluent Bit can load / run Golang plugin using two configuration file.
100+
101+
- Plugins configuration file
102+
- [Main configuration file](../administration/configuring-fluent-bit/classic-mode/configuration-file.md)
103+
104+
### Plugins configuration file
105+
106+
| Key | Description | Default Value|
107+
| ---- | ----------- | ------------ |
108+
| Path | A path for a Golang plugin. | |
109+
110+
#### Example
111+
112+
```python
113+
[PLUGINS]
114+
Path /path/to/out_gstdout.so
115+
```
116+
117+
### Main configuration file
118+
119+
The keys for Golang plugin available as of this version are described in the following table:
120+
121+
| Key | Description | Default Value|
122+
| ---- | ----------- | ------------ |
123+
| Plugins_file | Path for a plugins configuration file. A _plugins_ configuration file allows to define paths for external plugins, for an example [see here](https://github.com/fluent/fluent-bit/blob/master/conf/plugins.conf). | |
124+
125+
#### Example
126+
127+
The following is an example of a main configuration file.
128+
129+
```python
130+
[SERVICE]
131+
plugins_file /path/to/plugins.conf
132+
133+
[INPUT]
134+
Name dummy
135+
136+
[OUTPUT]
137+
Name gstdout
138+
```
139+
140+
### Run using a configuration file
141+
142+
We can load a main configuration file using `-c` option.
143+
Note: No need to specify a plugins configuration file from command line.
144+
145+
```text
146+
fluent-bit -c fluent-bit.conf
147+
```

0 commit comments

Comments
 (0)