Skip to content

docs(kubernetes-events): add missing parameters and fix defaults. #2273

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.

Sign up for GitHub

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

Open
eschabell wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(kubernetes-events): add missing parameters and fix defaults. #2273

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bca4af1
docs(kubernetes-events): add missing parameters and fix defaults
eschabell Dec 2, 2025
4480d9d
pipeline: inputs: kubernetes-events: removed two config parameters to…
eschabell Dec 4, 2025
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
43 changes: 22 additions & 21 deletions pipeline/inputs/kubernetes-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,27 @@ description: Collect Kubernetes events

Kubernetes exports events through the API server. This input plugin lets you retrieve those events as logs and process them through the pipeline.

## Configuration


| Key | Description | Default |
|-----------------------|--------------------------------------------------------------------------------|--------------------------------------------------------|
| `db` | Set a database file to keep track of recorded Kubernetes events. | _none_ |
| `db.sync` | Set a database sync method. Accepted values: `extra`, `full`, `normal`, `off`. | `normal` |
| `interval_sec` | Set the reconnect interval (seconds). | `0` |
| `interval_nsec` | Set the reconnect interval (sub seconds: nanoseconds). | `500000000` |
| `kube_url` | API Server endpoint. | `https://kubernetes.default.svc` |
| `kube_ca_file` | Kubernetes TLS CA file. | `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` |
| `kube_ca_path` | Kubernetes TLS ca path. | _none_ |
| `kube_token_file` | Kubernetes authorization token file. | `/var/run/secrets/kubernetes.io/serviceaccount/token` |
| `kube_token_ttl` | Kubernetes token time to live, until it's read again from the token file. | `10m` |
| `kube_request_limit` | Kubernetes limit parameter for events query, no limit applied when set to `0`. | `0` |
| `kube_retention_time` | Kubernetes retention time for events. | `1h` |
| `kube_namespace` | Kubernetes namespace to query events from. | `all` |
| `tls.debug` | Debug level between `0` (nothing) and `4` (every detail). | `0` |
| `tls.verify` | Enable or disable verification of TLS peer certificate. | `On` |
| `tls.vhost` | Set optional TLS virtual host. | _none_ |
## Configuration parameters

| Key | Description | Default |
|:----|:------------|:--------|
| `db` | Set a database file to keep track of recorded Kubernetes events. | _none_ |
| `db.journal_mode` | Set the journal mode for databases. Values: `DELETE`, `TRUNCATE`, `PERSIST`, `MEMORY`, `WAL`, `OFF`. | `WAL` |
| `db.locking` | Specify that the database will be accessed only by Fluent Bit. Enabling this feature helps increase performance when accessing the database but restricts external tools from querying the content. | `false` |
| `db.sync` | Set a database sync method. Values: `extra`, `full`, `normal`, `off`. | `normal` |
| `interval_nsec` | Set the reconnect interval (sub seconds: nanoseconds). | `500000000` |
| `interval_sec` | Set the reconnect interval (seconds). | `0` |
| `kube_ca_file` | Kubernetes TLS CA file. | `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt` |
| `kube_ca_path` | Kubernetes TLS CA path. | _none_ |
| `kube_namespace` | Kubernetes namespace to query events from. Gets events from all namespaces by default. | _none_ |
| `kube_request_limit` | Kubernetes limit parameter for events query. No limit applied when set to `0`. | `0` |
| `kube_retention_time` | Kubernetes retention time for events. | `1h` |
| `kube_token_file` | Kubernetes authorization token file. | `/var/run/secrets/kubernetes.io/serviceaccount/token` |
| `kube_token_ttl` | Kubernetes token time to live, until it's read again from the token file. | `10m` |
| `kube_url` | API Server endpoint. | `https://kubernetes.default.svc` |
| `tls.debug` | Set TLS debug level: `0` (no debug), `1` (error), `2` (state change), `3` (info), and `4` (verbose). | `0` |
| `tls.verify` | Enable or disable verification of TLS peer certificate. | `true` |
| `tls.vhost` | Set optional TLS virtual host. | _none_ |

In Fluent Bit 3.1 or later, this plugin uses a Kubernetes watch stream instead of polling. In versions earlier than 3.1, the interval parameters are used for reconnecting the Kubernetes watch stream.

Expand All @@ -41,7 +42,7 @@ The Kubernetes service account used by Fluent Bit must have `get`, `list`, and `

### Basic configuration file

In the following configuration file, the Kubernetes events plugin collects events every `5` seconds (default for `interval_nsec`) and exposes them through the [standard output plugin](../outputs/standard-output.md) on the console:
In the following configuration file, the Kubernetes events plugin collects events and exposes them through the [standard output plugin](../outputs/standard-output.md) on the console:


{% tabs %}
Expand Down