in_kubernetes_events: add missing config parameter descriptions. Fixes #11243.

[eschabell]

Add config_map entries for struct fields that were previously defined but not exposed as configuration options:

• db.locking: set exclusive locking mode for the database
• db.journal_mode: set the journal mode (DELETE, TRUNCATE,PERSIST, MEMORY, WAL, OFF)
• dns_retries: dns lookup retries until network starts working
• dns_wait_time: interval between network status checks
• Also add the missing db.sync property reading code and journal_mode validation in kubernetes_events_conf.c to properly handle these database configuration options.

Fixes issue #11243

---

Testing
Before we can approve your change; please submit the following in a comment:

• [N/A ] Example configuration file for the change
• [X ] Debug log output from testing the change

Added tests in_kubernetes_events: Add test coverage for the new configuration parameters:

• db.sync: test all valid values (extra, full, normal, off)
• db.journal_mode: test all valid values (DELETE, TRUNCATE, PERSIST,
  MEMORY, WAL, OFF)
• db.locking: test boolean values (true, false)
• dns_retries and dns_wait_time: test custom values

Add test_ctx_create_with_config() helper function to support testing
optional configuration parameters without modifying the existing
test context creator.

Did full Fluent Bit build with tests and ran:

$ ./bin/flb-rt-in_kubernetes_events 

...
[ OK ]
SUCCESS: All unit tests have passed.

• [N/A ] Attached Valgrind output that shows no leaks or memory corruption was found
• [N/A ] Run local packaging test showing all targets (including any new ones) build.
• [N/A ] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

• [X ] Documentation required for this feature

Docs PR: fluent/fluent-bit-docs#2273

Backporting

• [N/A ] Backport to latest stable release.

---

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

• New Features

  • Introduced new Kubernetes events plugin configuration options: DNS retries, DNS wait time, database locking, database journal mode, and database synchronization mode.
  • Added runtime validation for new database and DNS configuration settings.

• Tests

  • Added comprehensive test coverage for new configuration options.

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

[coderabbitai]

Walkthrough

The changes add four new configuration options to the Kubernetes events input plugin: dns_retries, dns_wait_time, db_locking, and db_journal_mode. These include corresponding struct fields, configuration validation logic for database synchronization and journal modes, and comprehensive test coverage for all new configuration parameters.

Changes

Cohort / File(s)	Summary
Configuration Option Declarations plugins/in_kubernetes_events/kubernetes_events.c	Added four new configuration entries: dns_retries (INT, default 6), dns_wait_time (TIME, default 30), db_locking (BOOL), and db_journal_mode (STR, default WAL) to the FLB_HAVE_SQLDB configuration block.
Data Structure Fields plugins/in_kubernetes_events/kubernetes_events.h	Added four new fields to the k8s_events struct corresponding to the new configuration options: dns_retries, dns_wait_time, db_locking, and db_journal_mode.
Configuration Validation Logic plugins/in_kubernetes_events/kubernetes_events_conf.c	Implemented validation for db.sync (accepts 0, 1, 2, 3; logs error for invalid values) and db.journal_mode (accepts DELETE, TRUNCATE, PERSIST, MEMORY, WAL, OFF; aborts initialization for invalid values). Validation occurs prior to database initialization.
Test Suite Extensions tests/runtime/in_kubernetes_events.c	Added helper function test_ctx_create_with_config for building test contexts with config overrides, and four new test functions: flb_test_config_db_sync_values, flb_test_config_db_journal_mode_values, flb_test_config_db_locking_values, and flb_test_config_dns_options. All tests exercise various configuration permutations and verify plugin lifecycle.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20–25 minutes

• Duplicated test helper: test_ctx_create_with_config is defined twice in the test file; should be consolidated into a single definition.
• Validation behavior discrepancy: Verify that invalid db.sync values log an error but permit continuation, whereas invalid db.journal_mode values properly abort and destroy context (ensure error handling is consistent and well-tested).
• Configuration wiring: Confirm all new struct fields are properly mapped to configuration entries and that defaults are applied correctly.
• Test coverage breadth: Ensure test permutations cover edge cases (e.g., boundary values for dns_retries and dns_wait_time).

Suggested labels

docs-required

Suggested reviewers

• edsiper
• cosmo0920
• leonardo-albertovich

Poem

🐰 New configs bloom like carrots in a row,
DNS retries and locking modes to flow,
Database journals waltz their merry way,
With tests to validate both night and day!
Hop, hop, hooray! 🥕✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 55.56% which is insufficient. The required threshold is 80.00%.	You can run @coderabbitai generate docstrings to improve docstring coverage.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: adding missing config parameter descriptions to the in_kubernetes_events plugin, which aligns with the actual changeset that introduces config_map entries and validation for database and DNS configuration options.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

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

---

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.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

tests/runtime/in_kubernetes_events.c (1)

526-560: Test verifies configuration acceptance but not actual behavior.

The test correctly verifies that all valid db.sync values are accepted during initialization. However, it doesn't verify that the database is actually configured with the specified sync mode. Consider adding verification that reads back the SQLite PRAGMA to confirm the setting was applied.

This is acceptable for a configuration validation test, but for more thorough coverage, you could query the database after initialization:

/* After flb_start, could verify with SQL query: */
/* SELECT * FROM pragma_synchronous; */

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10ebd3a and b4f88ba.

📒 Files selected for processing (3)

• plugins/in_kubernetes_events/kubernetes_events.c (1 hunks)
• plugins/in_kubernetes_events/kubernetes_events_conf.c (1 hunks)
• tests/runtime/in_kubernetes_events.c (2 hunks)

🧰 Additional context used

🧬 Code graph analysis (2)

plugins/in_kubernetes_events/kubernetes_events_conf.c (1)

src/flb_input.c (1)

• flb_input_get_property (776-780)

tests/runtime/in_kubernetes_events.c (2)

include/fluent-bit/flb_mem.h (2)

• flb_calloc (84-96)
• flb_free (126-128)

src/flb_lib.c (8)

• flb_create (143-225)
• flb_input (266-276)
• flb_input_set (305-335)
• flb_output (279-289)
• flb_output_set (520-551)
• flb_start (983-994)
• flb_stop (1011-1055)
• flb_destroy (228-263)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (31)

• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit, x64, x64-windows-static, 3.31.6)
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 32bit, x86, x86-windows-static, 3.31.6)
• GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DCMA...
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COMPILER_STRICT_POINTER_TYPES=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_ARROW=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_COVERAGE=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, clang, clang++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
• GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
• GitHub Check: PR - fuzzing test
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-22.04, clang-12)
• GitHub Check: pr-compile-without-cxx (3.31.6)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-24.04, clang-14)
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-24.04, clang-14)
• GitHub Check: pr-compile-centos-7
• GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)

🔇 Additional comments (9)

plugins/in_kubernetes_events/kubernetes_events_conf.c (1)

256-270: LGTM: db.journal_mode validation correctly aborts on invalid input.

The validation properly checks all allowed values and aborts initialization if an invalid value is provided, ensuring the database is never opened with an unsupported journal mode.

plugins/in_kubernetes_events/kubernetes_events.c (2)

1088-1099: LGTM: Database configuration entries are properly defined.

The db.locking and db.journal_mode configuration entries are correctly wired to their respective struct fields with appropriate defaults. These align with the validation logic added in kubernetes_events_conf.c.

---

1102-1111: Verify that dns_retries and dns_wait_time are actually used in the implementation.

The configuration entries are properly defined and mapped to struct fields, but ensure that the actual DNS retry logic references these values. These fields should be used in the DNS resolution logic; if they are not referenced anywhere in the implementation, the config map definitions should be removed or the implementation should be updated to use them.

tests/runtime/in_kubernetes_events.c (6)

306-383: LGTM: Test helper properly configures optional parameters.

The test_ctx_create_with_config function correctly creates a test context with optional database and DNS configuration parameters, using conditional logic to only set provided values. This is a clean approach for testing different configuration combinations.

---

562-596: Test coverage for db.journal_mode is appropriate.

The test validates all documented journal mode values (DELETE, TRUNCATE, PERSIST, MEMORY, WAL, OFF) and confirms they're accepted during initialization.

---

598-632: Test coverage for db.locking is complete.

The test validates both boolean values for the db.locking parameter.

---

634-664: DNS options test provides basic configuration validation.

The test confirms that dns_retries and dns_wait_time can be configured, though it doesn't verify their actual usage during DNS operations. This is sufficient for a configuration acceptance test.

---

670-673: Test suite properly registers all new configuration tests.

All four new test cases are correctly added to the TEST_LIST for execution.

---

306-383: The AI summary's claim of duplication appears unsupported by the provided code.

The function test_ctx_create_with_config shown in lines 306-383 appears only once in this snippet. Without access to verify the entire file, the claim of duplication cannot be confirmed from the evidence presented. If duplication exists elsewhere in the file, the line numbers should be explicitly cited.