From 44b70568d1ea006092e8c459dfc3f2e7b5d7684f Mon Sep 17 00:00:00 2001 From: "Eric D. Schabell" Date: Sat, 1 Aug 2026 14:24:41 +0200 Subject: [PATCH] docs: administration: yaml: document the extensions section - Add extensions to the list of supported top-level YAML sections. - Add an "extensions section" section describing it as a place to keep settings for tooling around Fluent Bit, which Fluent Bit parses and retains but the data pipeline never reads. - Note that extensions is the only section accepting nested maps, and that nesting elsewhere fails with "variant values are only valid in the extensions section". Note, update for code changes without corresponding docs PR. Signed-off-by: Eric D. Schabell --- administration/configuring-fluent-bit/yaml.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/administration/configuring-fluent-bit/yaml.md b/administration/configuring-fluent-bit/yaml.md index 4da2457ec..a930823ac 100644 --- a/administration/configuring-fluent-bit/yaml.md +++ b/administration/configuring-fluent-bit/yaml.md @@ -16,7 +16,31 @@ YAML configuration files support the following top-level sections: - `multiline_parsers`: Defines [custom multiline parsers](./yaml/multiline-parsers-section.md). - `plugins`: Defines paths for [custom plugins](./yaml/plugins-section.md). - `upstream_servers`: Defines [nodes](./yaml/upstream-servers-section.md) for output plugins. +- `extensions`: Carries [settings for external tooling](#extensions-section) that Fluent Bit parses but doesn't act on. {% hint style="info" %} YAML configuration is used in the smoke tests for containers. An always-correct up-to-date example is here: . {% endhint %} + +## `extensions` section + +The `extensions` section is available in Fluent Bit version 5.1 and greater. + +Use this section to store settings that belong to tooling around Fluent Bit, such as a management agent or a deployment system, in the same file as your pipeline. Fluent Bit parses and retains the section, but nothing in the data pipeline reads it. Adding it doesn't change how Fluent Bit collects, processes, or delivers data. + +Unlike other sections, `extensions` accepts arbitrarily nested maps, and preserves the type of each value. Group settings under a key that identifies the tool that consumes them: + +```yaml +service: + flush: 1 + log_level: info + +extensions: + opamp: + endpoint: 127.0.0.1:4318 + insecure: true + deployment: + config_version: 12345 +``` + +Nested values are only accepted in this section. Using a nested map elsewhere fails with `variant values are only valid in the extensions section`.