From 6288ccca7a18c156bb6008516f757edc7c2b93e6 Mon Sep 17 00:00:00 2001 From: Phillip Whelan Date: Thu, 21 Mar 2024 19:04:21 -0300 Subject: [PATCH] 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 | |