Skip to content

Commit f83157c

Browse files
authoredMar 2, 2017
Merge pull request fluent#14 from nokute78/configure
configuration: add a description about filter
2 parents bed594f + 48030af commit f83157c

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed
 

‎configuration/file.md

+27-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,14 @@ There are some cases where using the command line to start Fluent Bit is not ide
44

55
Fluent Bit allows to use one configuration file which works at a global scope and uses the [schema](configuration_schema.md) defined previously.
66

7-
The configuration file support three types of sections:
7+
The configuration file supports four types of sections:
88

99
- Service
1010
- Input
11+
- Filter
1112
- Output
1213

14+
1315
## Service
1416

1517
The _Service_ section defines global properties of the service, the keys available as of this version are described in the following table:
@@ -59,18 +61,40 @@ The following is an example of an _INPUT_ section:
5961
Tag my_cpu
6062
```
6163

64+
## Filter
65+
66+
A _FILTER_ section defines a filter (related to an filter plugin), here we will describe the base configuration for each _FILTER_ section. Note that each filter plugin may add it own configuration keys:
67+
68+
| Key | Description |
69+
|--------|---------------------------|
70+
| Name | Name of the filter plugin. |
71+
| Match | It sets a pattern to match certain records Tag. It's case sensitive and support the start (*) character as a wildcard. | |
72+
73+
74+
The _Name_ is mandatory and it let Fluent Bit know which filter plugin should be loaded. The _Match_ is mandatory for all plugins.
75+
76+
### Example
77+
78+
The following is an example of an _FILTER_ section:
79+
80+
```Python
81+
[FILTER]
82+
Name stdout
83+
Match *
84+
```
85+
6286
## Output
6387

6488
The _OUTPUT_ section specify a destination that certain records should follow after a Tag match. The configuration support the following keys:
6589

6690
| Key | Description |
6791
|--------|----------------------------|
6892
| Name | Name of the output plugin. |
69-
| Match | It set a pattern to match certain records Tag. It's case sensitive and support the start (*) character as a wildcard. |
93+
| Match | It sets a pattern to match certain records Tag. It's case sensitive and support the start (*) character as a wildcard. |
7094

7195
### Example
7296

73-
The following is an example of an _INPUT_ section:
97+
The following is an example of an _OUTPUT_ section:
7498

7599
```Python
76100
[OUTPUT]

0 commit comments

Comments
 (0)