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

[eschabell]

• Add missing config parameters: db.journal_mode, db.locking, dns_retries, dns_wait_time
• Fix tls.verify default from 'On' to 'true' to match source
• Fix kube_namespace default from 'all' to none
• Sort parameters alphabetically
• Align table format with other input plugin docs
• Expand tls.debug description with all debug levels

Fixes #2272.

Summary by CodeRabbit

• Documentation
  • Updated Kubernetes Events plugin configuration with new configuration parameters (DB journal/locking, DNS/tls options) and clearer default values.
  • Reordered and clarified interval semantics and namespace defaults (namespace now none by default).
  • Clarified that the plugin collects events without a fixed 5s interval and noted behavior changes for newer Fluent Bit watch streams.
  • Reworded examples and prose for improved readability and setup guidance.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Replaced the old "Configuration" section with a new "Configuration parameters" table in pipeline/inputs/kubernetes-events.md, adding database and DNS keys (e.g., db.journal_mode, db.locking, db.sync, dns_retries, dns_wait_time), reordering interval keys, clarifying defaults (e.g., tls.verify boolean, kube_namespace default _none_), and removing the fixed 5s interval statement.

Changes

Cohort / File(s)

Summary

Documentation Update pipeline/inputs/kubernetes-events.md

Replaced free-form configuration prose with a Configuration parameters table; added missing db and DNS keys (db.journal_mode, db.locking, db.sync, dns_retries, dns_wait_time); reordered interval fields (interval_nsec before interval_sec); clarified defaults and semantics for tls.verify (now boolean), kube_namespace (default _none_), and Kubernetes watch behavior; updated basic/config prose and retained threading/service-account/example sections with aligned wording.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

• Verify each newly documented parameter and default matches implementation: db.journal_mode, db.locking, db.sync, dns_retries, dns_wait_time.
• Check interval ordering and any implications for precedence (interval_nsec vs interval_sec).
• Confirm tls.verify type and default, and kube_namespace default semantics.
• Validate prose changes that removed the fixed 5s interval claim against actual plugin behavior.

Poem

🐇 I hopped through rows of config and light,
Found five shy keys hiding out of sight,
Tables arranged, defaults set right,
Events now documented, cozy and bright,
Hop hop — the docs are stitched tight!

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs(kubernetes-events): add missing parameters and fix defaults' accurately summarizes the main changes: documenting missing configuration parameters and correcting default values.
Linked Issues check	✅ Passed	The PR directly addresses the objectives in linked issue #2272 by documenting all five missing parameters (db.sync, db.journal_mode, db.locking, dns_retries, dns_wait_time) and fixing default values to match source code.
Out of Scope Changes check	✅ Passed	All changes are in-scope: documentation parameter additions, default value corrections, alphabetical sorting, table format alignment, and description expansions directly support the issue objectives.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bca4af1 and 4480d9d.

📒 Files selected for processing (1)

• pipeline/inputs/kubernetes-events.md (2 hunks)

🔇 Additional comments (4)

pipeline/inputs/kubernetes-events.md (4)

11-29: Alphabetical parameter ordering is correct.

Parameters are properly sorted in alphabetical order across the full configuration table, maintaining logical readability.

---

14-28: Defaults and descriptions updated correctly.

All default values are properly updated per PR objectives:

• tls.verify → true (instead of On)
• kube_namespace → _none_ (instead of all)
• tls.debug expanded to show all levels (0–4)
• Database parameters documented with appropriate defaults

Descriptions are clear and comprehensive.

---

31-31: Prose updates align with configuration changes.

The contextual explanation on Line 31 properly clarifies that Fluent Bit 3.1+ uses a watch stream, and the Basic configuration description on Line 45 has been appropriately updated to reflect the new plugin behavior (removing the prior fixed-interval reference).

Also applies to: 45-45

---

9-29: Resolve: The dns_retries and dns_wait_time parameters do not apply to the kubernetes-events input plugin.

These DNS parameters belong to the kubernetes filter (used for pod metadata enrichment), not the kubernetes-events input (which reads Kubernetes event objects). The kubernetes-events input does not have dedicated DNS configuration parameters—DNS resolution is handled by the cluster's networking layer. The configuration table in the file is correct and complete for the kubernetes-events input plugin.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[eschabell]

AI review passed but waiting on code PR to be merged here as configuration parameters don't exist until then: fluent/fluent-bit#11244

[eschabell]

Based on changes requested in the code PR, adjusting docs PR here to match.