From 6288ccca7a18c156bb6008516f757edc7c2b93e6 Mon Sep 17 00:00:00 2001 From: Phillip Whelan Date: Thu, 21 Mar 2024 19:04:21 -0300 Subject: [PATCH 1/4] Create exit.md Signed-off-by: Phillip Whelan --- pipeline/outputs/exit.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 pipeline/outputs/exit.md diff --git a/pipeline/outputs/exit.md b/pipeline/outputs/exit.md new file mode 100644 index 000000000..e0a38e3f9 --- /dev/null +++ b/pipeline/outputs/exit.md @@ -0,0 +1,20 @@ +--- +description: 'Exit fluent-bit after a number of flushes, records or seconds' +--- + +# Exit + +The exit plugin is a utility plugin which will cause fluent-bit to exit after one of the following occurs: + * receiving a set number of records (record_count). + * being flushed a set number of times (flush_count). + * being flushed after a set number of seconds have transpired (time_count). + +At least one of these parameters must be set. If more than one is set it will wait until any one of the set conditions is met. + +## Configuration Parameters + +| Key | Description | default | +| :--- | :--- | :--- | +| Record\_Count | Number of records to wait for before exiting | | +| Flush\_Count | Number of flushes to wait for before exiting | | +| Time\_Count | Number of seconds to wait for before exiting | | From 04d959af672a7901db709595599b9d20b60d79bc Mon Sep 17 00:00:00 2001 From: Lynette Miles <6818907+esmerel@users.noreply.github.com> Date: Wed, 22 Oct 2025 09:40:14 -0700 Subject: [PATCH 2/4] Update SUMMARY.md Hopefully I'm adding the new exit output to the summary file to the PR where the exit docs are being added. Signed-off-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 057fa2e64..00f18d254 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -162,6 +162,7 @@ * [Counter](pipeline/outputs/counter.md) * [Datadog](pipeline/outputs/datadog.md) * [Elasticsearch](pipeline/outputs/elasticsearch.md) + * [Exit](pipeline/outputs/exit.md) * [File](pipeline/outputs/file.md) * [FlowCounter](pipeline/outputs/flowcounter.md) * [Forward](pipeline/outputs/forward.md) From ec86c512e276ed9a46ed072b4985f8678ceb7790 Mon Sep 17 00:00:00 2001 From: Lynette Miles <6818907+esmerel@users.noreply.github.com> Date: Wed, 22 Oct 2025 14:36:47 -0700 Subject: [PATCH 3/4] Apply suggestions from code review Merging markdownlint complaints so they're not confusing anyone. Signed-off-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> --- pipeline/outputs/exit.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/pipeline/outputs/exit.md b/pipeline/outputs/exit.md index e0a38e3f9..5b5286309 100644 --- a/pipeline/outputs/exit.md +++ b/pipeline/outputs/exit.md @@ -1,15 +1,16 @@ --- -description: 'Exit fluent-bit after a number of flushes, records or seconds' +description: Exit Fluent Bit after a number of flushes, records, or seconds. --- # Exit -The exit plugin is a utility plugin which will cause fluent-bit to exit after one of the following occurs: - * receiving a set number of records (record_count). - * being flushed a set number of times (flush_count). - * being flushed after a set number of seconds have transpired (time_count). +The _exit_ plugin is a utility plugin which causes Fluent Bit to exit after one of the following occurs: -At least one of these parameters must be set. If more than one is set it will wait until any one of the set conditions is met. +- receiving a set number of records (`record_count`). +- being flushed a set number of times (`flush_count`). +- being flushed after a set number of seconds have transpired (`time_count`). + +At least one of these parameters must be set. If more than one is set the plugin exits when any one of the set conditions is met. ## Configuration Parameters From 42b8fef4fcc5e3c1c9bf21a538709ce613704168 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Lecaros?= Date: Thu, 23 Oct 2025 09:08:30 -0300 Subject: [PATCH 4/4] out_exit: document new parameters for PR#8621 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Lynette Miles <6818907+esmerel@users.noreply.github.com> Signed-off-by: José Lecaros --- pipeline/outputs/exit.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pipeline/outputs/exit.md b/pipeline/outputs/exit.md index 5b5286309..2ad9ed4e7 100644 --- a/pipeline/outputs/exit.md +++ b/pipeline/outputs/exit.md @@ -12,10 +12,10 @@ The _exit_ plugin is a utility plugin which causes Fluent Bit to exit after one At least one of these parameters must be set. If more than one is set the plugin exits when any one of the set conditions is met. -## Configuration Parameters +## Configuration parameters -| Key | Description | default | +| Key | Description | Default | | :--- | :--- | :--- | -| Record\_Count | Number of records to wait for before exiting | | -| Flush\_Count | Number of flushes to wait for before exiting | | -| Time\_Count | Number of seconds to wait for before exiting | | +| `Record_Count` | Number of records to wait for before exiting. | _none_ | +| `Flush_Count` | Number of flushes to wait for before exiting.| _none_ | +| `Time_Count` | Number of seconds to wait for before exiting. | _none_ |