You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: administration/configuring-fluent-bit/configuration-file.md
+45-46Lines changed: 45 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,26 +17,26 @@ In addition, it's also possible to split the main configuration file in multiple
17
17
18
18
* Include File
19
19
20
-
## Service <aid="config_section"></a>
20
+
## Service <ahref="config_section"id="config_section"></a>
21
21
22
22
The _Service_ section defines global properties of the service, the keys available as of this version are described in the following table:
23
23
24
-
| Key | Description | Default Value |
25
-
|:--- |:--- |:--- |
26
-
| Flush | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. | 5 |
27
-
| Grace | Set the grace time in `seconds` as Integer value. The engine loop uses a Grace timeout to define wait time on exit | 5 |
28
-
| Daemon | Boolean value to set if Fluent Bit should run as a Daemon \(background\) or not. Allowed values are: yes, no, on and off. note: If you are using a Systemd based unit as the one we provide in our packages, do not turn on this option. | Off |
29
-
|Log\_File | Absolute path for an optional log file. By default all logs are redirected to the standard error interface \(stderr\). ||
30
-
|Log\_Level | Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that _trace_ mode is only available if Fluent Bit was built with the _WITH\_TRACE_ option enabled. | info |
31
-
|Parsers\_File | Path for a `parsers` configuration file. Multiple Parsers\_File entries can be defined within the section. ||
32
-
|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). ||
33
-
|Streams\_File | Path for the Stream Processor configuration file. To learn more about Stream Processing configuration go [here](../../stream-processing/introduction.md). ||
34
-
|HTTP\_Server | Enable built-in HTTP Server | Off |
35
-
|HTTP\_Listen | Set listening interface for HTTP Server when it's enabled | 0.0.0.0 |
36
-
|HTTP\_Port | Set TCP Port for the HTTP Server | 2020 |
37
-
|Coro\_Stack\_Size| Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value \(say 4096\), or coroutine threads can overrun the stack buffer. Do not change the default value of this parameter unless you know what you are doing. | 24576 |
38
-
| scheduler.cap | Set a maximum retry time in second. The property is supported from v1.8.7. |2000|
39
-
| scheduler.base | Set a base of exponential backoff. The property is supported from v1.8.7. |5|
| Flush | Set the flush time in `seconds.nanoseconds`. The engine loop uses a Flush timeout to define when is required to flush the records ingested by input plugins through the defined output plugins. | 5|
27
+
| Grace | Set the grace time in `seconds` as Integer value. The engine loop uses a Grace timeout to define wait time on exit | 5|
28
+
| Daemon | Boolean value to set if Fluent Bit should run as a Daemon (background) or not. Allowed values are: yes, no, on and off. note: If you are using a Systemd based unit as the one we provide in our packages, do not turn on this option. | Off|
29
+
|Log_File | Absolute path for an optional log file. By default all logs are redirected to the standard error interface (stderr). ||
30
+
|Log_Level | Set the logging verbosity level. Allowed values are: error, warn, info, debug and trace. Values are accumulative, e.g: if 'debug' is set, it will include error, warning, info and debug. Note that _trace_ mode is only available if Fluent Bit was built with the _WITH_TRACE_ option enabled. | info|
31
+
|Parsers_File | Path for a `parsers` configuration file. Multiple Parsers_File entries can be defined within the section. ||
32
+
|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). ||
33
+
|Streams_File | Path for the Stream Processor configuration file. To learn more about Stream Processing configuration go [here](../../stream-processing/introduction.md). ||
34
+
|HTTP_Server | Enable built-in HTTP Server | Off|
35
+
|HTTP_Listen | Set listening interface for HTTP Server when it's enabled | 0.0.0.0|
36
+
|HTTP_Port | Set TCP Port for the HTTP Server | 2020|
37
+
|Coro_Stack_Size| Set the coroutines stack size in bytes. The value must be greater than the page size of the running system. Don't set too small value (say 4096), or coroutine threads can overrun the stack buffer. Do not change the default value of this parameter unless you know what you are doing. | 24576|
38
+
| scheduler.cap | Set a maximum retry time in second. The property is supported from v1.8.7. |2000|
39
+
| scheduler.base | Set a base of exponential backoff. The property is supported from v1.8.7. | 5 |
40
40
41
41
The following is an example of a _SERVICE_ section:
42
42
@@ -47,16 +47,16 @@ The following is an example of a _SERVICE_ section:
An _INPUT_ section defines a source \(related to an input plugin\), here we will describe the base configuration for each _INPUT_ section. Note that each input plugin may add it own configuration keys:
52
+
An _INPUT_ section defines a source (related to an input plugin), here we will describe the base configuration for each _INPUT_ section. Note that each input plugin may add it own configuration keys:
53
53
54
-
| Key | Description |
55
-
|:--- |:--- |
56
-
| Name | Name of the input plugin. |
57
-
| Tag | Tag name associated to all records coming from this plugin. |
| Tag | Tag name associated to all records coming from this plugin. |
58
58
59
-
The _Name_ is mandatory and it let Fluent Bit know which input plugin should be loaded. The _Tag_ is mandatory for all plugins except for the _input forward_ plugin \(as it provides dynamic tags\).
59
+
The _Name_ is mandatory and it let Fluent Bit know which input plugin should be loaded. The _Tag_ is mandatory for all plugins except for the _input forward_ plugin (as it provides dynamic tags).
60
60
61
61
### Example
62
62
@@ -68,37 +68,37 @@ The following is an example of an _INPUT_ section:
A _FILTER_ section defines a filter \(related to a filter plugin\), here we will describe the base configuration for each _FILTER_ section. Note that each filter plugin may add it own configuration keys:
73
+
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:
74
74
75
-
| Key | Description ||
76
-
|:--- |:--- |:--- |
77
-
| Name | Name of the filter plugin. ||
78
-
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star \(\*\) character as a wildcard. ||
79
-
|Match\_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. ||
79
+
|Match_Regex| A regular expression to match against the tags of incoming records. Use this option if you want to use the full regex syntax. ||
80
80
81
-
The _Name_ is mandatory and it let Fluent Bit know which filter plugin should be loaded. The _Match_ or _Match\_Regex_ is mandatory for all plugins. If both are specified, _Match\_Regex_ takes precedence.
81
+
The _Name_ is mandatory and it let Fluent Bit know which filter plugin should be loaded. The _Match_ or _Match_Regex_ is mandatory for all plugins. If both are specified, _Match_Regex_ takes precedence.
82
82
83
83
### Example
84
84
85
-
The following is an example of a_FILTER_ section:
85
+
The following is an example of an_FILTER_ section:
0 commit comments