diff --git a/docs/includes/startup_error_behavior.md b/docs/includes/startup_error_behavior.md new file mode 100644 index 000000000..71ddf5715 --- /dev/null +++ b/docs/includes/startup_error_behavior.md @@ -0,0 +1,11 @@ +In addition to the plugin-specific and global configuration settings the plugin +supports options for specifying the behavior when experiencing startup errors +using the `startup_error_behavior` setting. Available values are: + +- `error`: Telegraf with stop and exit in case of startup errors. This is the + default behavior. +- `ignore`: Telegraf will ignore startup errors for this plugin and disables it + but continues processing for all other plugins. +- `retry`: Telegraf will try to startup the plugin in every gather or write + cycle in case of startup errors. The plugin is disabled until + the startup succeeds. diff --git a/plugins/outputs/kafka/README.md b/plugins/outputs/kafka/README.md index 45922f1a6..16b1d3b60 100644 --- a/plugins/outputs/kafka/README.md +++ b/plugins/outputs/kafka/README.md @@ -12,6 +12,20 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins +## Startup error behavior options + +In addition to the plugin-specific and global configuration settings the plugin +supports options for specifying the behavior when experiencing startup errors +using the `startup_error_behavior` setting. Available values are: + +- `error`: Telegraf with stop and exit in case of startup errors. This is the + default behavior. +- `ignore`: Telegraf will ignore startup errors for this plugin and disables it + but continues processing for all other plugins. +- `retry`: Telegraf will try to startup the plugin in every gather or write + cycle in case of startup errors. The plugin is disabled until + the startup succeeds. + ## Secret-store support This plugin supports secrets from secret-stores for the `sasl_username`, diff --git a/tools/readme_config_includer/generator.go b/tools/readme_config_includer/generator.go index 9f5ec5d3f..9914e01e4 100644 --- a/tools/readme_config_includer/generator.go +++ b/tools/readme_config_includer/generator.go @@ -189,6 +189,8 @@ func main() { log.Printf("heading without lines: %s", string(rawnode.Text(readme))) stop = start // safety measure to prevent removing all text } + // Make sure we also iterate the present heading + rawnode = h.PreviousSibling() break } }