Skip to content
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.

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

out_exit: document new parameters for PR#8621. #1346

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
20 changes: 20 additions & 0 deletions pipeline/outputs/exit.md
Original file line number Diff line number Diff line change
@@ -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 | |