Skip to content

admin/config/yaml/env-variable style updates #1657

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 2 commits into from
May 15, 2025
Merged

admin/config/yaml/env-variable style updates #1657

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3da9e70
admin/config/yaml/env-variable style updates
esmerel May 14, 2025
537f66f
Update administration/configuring-fluent-bit/yaml/environment-variabl…
esmerel May 15, 2025
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
21 changes: 12 additions & 9 deletions administration/configuring-fluent-bit/yaml/environment-variables-section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Environment Variables Section
# Environment variables section

The `env` section allows you to define environment variables directly within the configuration file. These variables can then be used to dynamically replace values throughout your configuration using the `${VARIABLE_NAME}` syntax.
The `env` section lets you define environment variables directly within the configuration file. These variables can then be used to dynamically replace values throughout your configuration using the `${VARIABLE_NAME}` syntax.

Values set in the `env` section are case-sensitive. However, as a best practice, we recommend using uppercase names for environment variables. The example below defines two variables, `FLUSH_INTERVAL` and `STDOUT_FMT`, which can be accessed in the configuration using `${FLUSH_INTERVAL}` and `${STDOUT_FMT}`:
Values set in the `env` section are case-sensitive. However, as a best practice,
Fluent Bit recommends using uppercase names for environment variables. The following
example defines two variables, `FLUSH_INTERVAL` and `STDOUT_FMT`, which can be
accessed in the configuration using `${FLUSH_INTERVAL}` and `${STDOUT_FMT}`:

```yaml
env:
Expand All @@ -23,19 +26,19 @@ pipeline:
format: ${STDOUT_FMT}
```

## Predefined Variables
## Predefined variables

Fluent Bit provides a set of predefined environment variables that can be used in your configuration:

| Name | Description |
|--|--|
| ---- | ----------- |
| `${HOSTNAME}` | The system's hostname. |

## External Variables
## External variables

In addition to variables defined in the configuration file or the predefined ones, Fluent Bit can access system environment variables set in the user space. These external variables can be referenced in the configuration using the same ${VARIABLE_NAME} pattern.
In addition to variables defined in the configuration file or the predefined ones, Fluent Bit can access system environment variables set in the user space. These external variables can be referenced in the configuration using the same `${VARIABLE_NAME}` pattern.

For example, to set the FLUSH_INTERVAL system environment variable to 2 and use it in your configuration:
For example, to set the `FLUSH_INTERVAL` system environment variable to `2` and use it in your configuration:

```bash
export FLUSH_INTERVAL=2
Expand All @@ -58,4 +61,4 @@ pipeline:
format: json_lines
```

This approach allows you to easily manage and override configuration values using environment variables, providing flexibility in various deployment environments.
This approach lets you manage and override configuration values using environment variables, providing flexibility in various deployment environments.