Skip to content

Commit

Permalink
Document configuring plugin log_level (#763)
Browse files Browse the repository at this point in the history 
* administration: configuration: add log_level

Log_Level can be set for individual plugins the same way it can be set
for the service as a whole. Add this to the configuration docs.

Signed-off-by: Annette Wilson <[email protected]>
  • Loading branch information
@annettejanewilson
annettejanewilson authored Nov 9, 2022
1 parent d0cd5b5 commit 415db1c
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 28 deletions.
31 changes: 17 additions & 14 deletions administration/configuring-fluent-bit/classic-mode/configuration-file.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,11 @@ 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:

| Key | Description |
| ---- | ----------------------------------------------------------- |
| Name | Name of the input plugin. |
| Tag | Tag name associated to all records coming from this plugin. |
| Key | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the input plugin. |
| Tag | Tag name associated to all records coming from this plugin. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

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).

Expand All @@ -74,11 +75,12 @@ The following is an example of an _INPUT_ section:

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:

| Key | Description | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------- | - |
| Name | Name of the filter plugin. | |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. | |
| 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. | |
| Key | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the filter plugin. |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

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.

Expand All @@ -97,11 +99,12 @@ The following is an example of an _FILTER_ section:

The _OUTPUT_ section specify a destination that certain records should follow after a Tag match. Currently, Fluent Bit can route up to 256 _OUTPUT_ plugins. The configuration support the following keys:

| Key | Description | |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------- | - |
| Name | Name of the output plugin. | |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. | |
| 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. | |
| Key | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the output plugin. |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

### Example

Expand Down
31 changes: 17 additions & 14 deletions administration/configuring-fluent-bit/yaml/configuration-file.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,11 @@ pipeline:

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:

| Key | Description |
| ---- |--------------------------------------------------------------------------|
| Name | Name of the input plugin. Defined as subsection of the _inputs_ section. |
| Tag | Tag name associated to all records coming from this plugin. |
| Key | Description |
| ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the input plugin. Defined as subsection of the _inputs_ section. |
| Tag | Tag name associated to all records coming from this plugin. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

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).

Expand All @@ -105,11 +106,12 @@ pipeline:

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:

| Key | Description |
|--- |---------------------------------------------------------------------------------------------------------------------------------|
| Name | Name of the filter plugin. Defined as a subsection of the _filters_ section. |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Key | Description |
|------------ |-------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the filter plugin. Defined as a subsection of the _filters_ section. |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

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.

Expand All @@ -129,11 +131,12 @@ pipeline:

The _outputs_ section specify a destination that certain records should follow after a Tag match. Currently, Fluent Bit can route up to 256 _OUTPUT_ plugins. The configuration support the following keys:

| Key | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the output plugin. Defined as a subsection of the _outputs_ section. | |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Key | Description |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Name of the output plugin. Defined as a subsection of the _outputs_ section. |
| Match | A pattern to match against the tags of incoming records. It's case sensitive and support the star (\*) character as a wildcard. |
| 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. |
| Log_Level | Set the plugin's logging verbosity level. Allowed values are: off, error, warn, info, debug and trace. Defaults to the _SERVICE_ section's _Log_Level._ |

#### Example

Expand Down

0 comments on commit 415db1c

Please sign in to comment.