From 69ceb3db2cf6f6796d617183c0c653d8fe6e694d Mon Sep 17 00:00:00 2001 From: Lynette Miles Date: Tue, 13 May 2025 14:05:52 -0700 Subject: [PATCH 1/2] Admin: config plugins: yaml: Style updates Signed-off-by: Lynette Miles --- .../yaml/plugins-section.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/administration/configuring-fluent-bit/yaml/plugins-section.md b/administration/configuring-fluent-bit/yaml/plugins-section.md index ae2ebc27f..4b54a1723 100644 --- a/administration/configuring-fluent-bit/yaml/plugins-section.md +++ b/administration/configuring-fluent-bit/yaml/plugins-section.md @@ -1,8 +1,11 @@ -# 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: @@ -22,9 +25,12 @@ 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: @@ -46,8 +52,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. From 8d2337afcd7b653a42bdfa8c54a8330f9a3dec0f Mon Sep 17 00:00:00 2001 From: Lynette Miles <6818907+esmerel@users.noreply.github.com> Date: Wed, 14 May 2025 08:21:27 -0700 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Alexa Kreizinger Signed-off-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> --- .../configuring-fluent-bit/yaml/plugins-section.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/administration/configuring-fluent-bit/yaml/plugins-section.md b/administration/configuring-fluent-bit/yaml/plugins-section.md index 4b54a1723..77271f660 100644 --- a/administration/configuring-fluent-bit/yaml/plugins-section.md +++ b/administration/configuring-fluent-bit/yaml/plugins-section.md @@ -1,9 +1,6 @@ # Plugins section -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: +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: ## Inline YAML @@ -27,8 +24,7 @@ pipeline: ## YAML plugins file included using the `plugins_file` option -You can load external plugins from a separate YAML file by specifying the -`plugins_file` option in the service section for better modularity. +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: