Skip to content

Admin: config plugins: yaml: Style updates #1651

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 19, 2025
Merged

Admin: config plugins: yaml: Style updates #1651

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69ceb3d
Admin: config plugins: yaml: Style updates
esmerel May 13, 2025
8d2337a
Apply suggestions from code review
esmerel May 14, 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
17 changes: 7 additions & 10 deletions administration/configuring-fluent-bit/yaml/plugins-section.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Plugins Section
# Plugins section

While Fluent Bit comes with a variety of built-in plugins, it also supports loading external plugins at runtime. This feature is especially useful for loading Go or Wasm plugins that are built as shared object files (.so). Fluent Bit's YAML configuration provides two ways to load these external plugins:
Fluent Bit comes with a variety of built-in plugins, and also supports loading external plugins at runtime. This feature is especially useful for loading Go or WebAssembly (Wasm) plugins that are built as shared object files (.so). Fluent Bit YAML configuration provides the following ways to load these external plugins:

## 1. Inline YAML Section
## Inline YAML

You can specify external plugins directly within your main YAML configuration file using the `plugins` section. Here's an example:

Expand All @@ -22,9 +22,11 @@ pipeline:
match: '*'
```

## 2. YAML Plugins File Included using the `plugins_file` Option
## YAML plugins file included using the `plugins_file` option

Alternatively, you can load external plugins from a separate YAML file by specifying the `plugins_file` option in the service section. Here's how to configure this:
You can load external plugins from a separate YAML file by specifying the `plugins_file` option in the service section for better modularity.

To configure this:

```yaml
service:
Expand All @@ -46,8 +48,3 @@ In this setup, the `extra_plugins.yaml` file might contain the following plugins
plugins:
- /other/path/to/out_gstdout.so
```

### Key Points

- Built-in versus External: Fluent Bit comes with many built-in plugins, but you can load external plugins at runtime to extend the tool's functionality.
- Loading Mechanism: External plugins must be shared object files (.so). You can define them inline in the main YAML configuration or include them from a separate YAML file for better modularity.