Skip to content

Admin/config/classic: style updates #1668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 19, 2025
Merged

Admin/config/classic: style updates #1668

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 26 additions & 19 deletions administration/configuring-fluent-bit/classic-mode/commands.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,19 @@

Configuration files must be flexible enough for any deployment need, but they must keep a clean and readable format.

Fluent Bit _Commands_ extends a configuration file with specific built-in features. The list of commands available as of Fluent Bit 0.12 series are:
Fluent Bit `Commands` extends a configuration file with specific built-in features.
The following commands are available:

| Command | Prototype | Description |
| :--- | :--- | :--- |
| [@INCLUDE](commands.md#cmd_include) | @INCLUDE FILE | Include a configuration file |
| [@SET](commands.md#cmd_set) | @SET KEY=VAL | Set a configuration variable |
| [`@INCLUDE`](commands.md#cmd_include) | `@INCLUDE FILE` | Include a configuration file. |
| [`@SET`](commands.md#cmd_set) | `@SET KEY=VAL` | Set a configuration variable. |

## @INCLUDE Command <a id="cmd_include"></a>
## `@INCLUDE` <a id="cmd_include"></a>

Configuring a logging pipeline might lead to an extensive configuration file. In order to maintain a human-readable configuration, it's suggested to split the configuration in multiple files.
Configuring a logging pipeline might lead to an extensive configuration file. In order to maintain a human-readable configuration, split the configuration in multiple files.

The @INCLUDE command allows the configuration reader to include an external configuration file, e.g:
The `@INCLUDE` command allows the configuration reader to include an external configuration file:

```text
[SERVICE]
Expand All @@ -23,9 +24,19 @@ The @INCLUDE command allows the configuration reader to include an external conf
@INCLUDE outputs.conf
```

The above example defines the main service configuration file and also include two files to continue the configuration:
This example defines the main service configuration file and also includes two files to continue the configuration.

### inputs.conf
Fluent Bit will respects the following order when including:

- Service
- Inputs
- Filters
- Outputs

### `inputs.conf`

The following is an example of an `inputs.conf` file, like the one called in the
previous example.

```text
[INPUT]
Expand All @@ -40,6 +51,9 @@ The above example defines the main service configuration file and also include t

### outputs.conf

The following is an example of an `outputs.conf` file, like the one called in the
previous example.

```text
[OUTPUT]
Name stdout
Expand All @@ -53,20 +67,14 @@ The above example defines the main service configuration file and also include t
Logstash_Format On
```

Note that despites the order of inclusion, Fluent Bit will **ALWAYS** respect the following order:
## `@SET` <a id="cmd_set"></a>

* Service
* Inputs
* Filters
* Outputs
Fluent Bit supports [configuration variables](variables.md). One way to expose this variables to Fluent Bit is through setting a shell environment variable, the other is through the `@SET` command.

## @SET Command <a id="cmd_set"></a>

Fluent Bit supports [configuration variables](variables.md), one way to expose this variables to Fluent Bit is through setting a Shell environment variable, the other is through the _@SET_ command.

The @SET command can only be used at root level of each line, meaning it cannot be used inside a section, e.g:
The `@SET` command can only be used at root level of each line. It can't be used inside a section:

```text
// DO NOT USE
@SET my_input=cpu
@SET my_output=stdout

Expand All @@ -79,4 +87,3 @@ The @SET command can only be used at root level of each line, meaning it cannot
[OUTPUT]
Name ${my_output}
```