-
Notifications
You must be signed in to change notification settings - Fork 1.8k
in_kubernetes_events: add missing config parameter descriptions. Fixes #11243. #11244
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
base: master
Are you sure you want to change the base?
in_kubernetes_events: add missing config parameter descriptions. Fixes #11243. #11244
Conversation
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 Signed-off-by: Eric D. Schabell <[email protected]>
…validation Added the missing db.sync property reading code and journal_mode validation in kubernetes_events_conf.c to properly handle new database configuration options. Signed-off-by: Eric D. Schabell <[email protected]>
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. Signed-off-by: Eric D. Schabell <[email protected]>
WalkthroughAdded two SQLDB-related configuration options and runtime validation for DB settings in the Kubernetes events input, extended runtime tests exercising DB config permutations, and removed two DNS-related fields from the plugin's public struct. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20–30 minutes
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.syncvalues 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
📒 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.lockinganddb.journal_modeconfiguration entries are correctly wired to their respective struct fields with appropriate defaults. These align with the validation logic added inkubernetes_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_configfunction 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.lockingparameter.
634-664: DNS options test provides basic configuration validation.The test confirms that
dns_retriesanddns_wait_timecan 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_configshown 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.
Both db.sync and db.journal_mode now abort initialization on invalid values for consistent error handling. Signed-off-by: Eric D. Schabell <[email protected]>
|
thanks for this PR. I noticed that while Database options have a proper code, there is no code handling for There might be cases where in addition to the config map registration, we need to check if that option/flag is actually used. |
…fig options Remove config_map entries for dns_retries and dns_wait_time options. These configuration parameters were registered but never used anywhere in the plugin code, unlike filter_kubernetes which has actual DNS retry logic implementation. Signed-off-by: Eric D. Schabell <[email protected]>
Remove dns_retries and dns_wait_time struct members from k8s_events. These fields were stored but never used by the plugin, making them dead code that should not be exposed to users. Signed-off-by: Eric D. Schabell <[email protected]>
Remove dns_retries and dns_wait_time from test_ctx_create_with_config() and remove the flb_test_config_dns_options test. These options were removed from the plugin as they had no actual implementation. Signed-off-by: Eric D. Schabell <[email protected]>
|
@edsiper pushed changes for requested removal of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
tests/runtime/in_kubernetes_events.c (1)
306-373: Reduce duplication by reusing existing test_ctx_create / test_ctx_destroy
test_ctx_create_with_config()largely duplicatestest_ctx_create()plus a few extraflb_input_setcalls fordb.*options. To keep tests simpler to maintain, consider factoring this as:
- Call
test_ctx_create()to build the base context.- Then apply the optional
db.sync,db.locking, anddb.journal_modeoverrides.- Reuse
test_ctx_destroy()for cleanup in callers instead of open‑codingflb_stop/flb_destroy/flb_freein each test.This avoids drift if the common setup/teardown ever changes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
plugins/in_kubernetes_events/kubernetes_events.c(1 hunks)plugins/in_kubernetes_events/kubernetes_events.h(0 hunks)plugins/in_kubernetes_events/kubernetes_events_conf.c(1 hunks)tests/runtime/in_kubernetes_events.c(2 hunks)
💤 Files with no reviewable changes (1)
- plugins/in_kubernetes_events/kubernetes_events.h
🚧 Files skipped from review as they are similar to previous changes (1)
- plugins/in_kubernetes_events/kubernetes_events_conf.c
🧰 Additional context used
🧬 Code graph analysis (1)
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_service_set(652-678)flb_input(266-276)flb_input_set(305-335)flb_output(279-289)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 (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DCMA...
- 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, x64, x64-windows-static, 3.31.6)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 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=On, 3.31.6, gcc, g++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=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 (-DFLB_SANITIZE_THREAD=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_ARROW=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_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
- 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, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=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_SMALL=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_SMALL=On, 3.31.6, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
- GitHub Check: PR - fuzzing test
- GitHub Check: pr-compile-centos-7
- 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-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)
- 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)
🔇 Additional comments (1)
plugins/in_kubernetes_events/kubernetes_events.c (1)
1088-1099: DB config options wired correctly into config_mapThe
db.lockinganddb.journal_modeentries look consistent with the existingdb/db.syncoptions: correct map types, sensible defaults, and offsets intostruct k8s_eventsguarded byFLB_HAVE_SQLDB. No issues from this file’s side.
|
@eschabell thanks for the updates, as a last steps we just need to clean the history of commits
|

Add
config_mapentries for struct fields that were previously defined but not exposed as configuration options:db.locking: set exclusive locking mode for the databasedb.journal_mode: set the journal mode (DELETE,TRUNCATE,PERSIST,MEMORY,WAL,OFF)dns_retries: dns lookup retries until network starts workingdns_wait_time: interval between network status checksdb.syncproperty reading code andjournal_modevalidation inkubernetes_events_conf.cto properly handle these database configuration options.Fixes issue #11243
Testing
Before we can approve your change; please submit the following in a comment:
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_retriesanddns_wait_time: test custom valuesAdd
test_ctx_create_with_config()helper function to support testingoptional configuration parameters without modifying the existing
test context creator.
Did full Fluent Bit build with tests and ran:
ok-package-testlabel to test for all targets (requires maintainer to do).Documentation
Docs PR: fluent/fluent-bit-docs#2273
Backporting
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
✏️ Tip: You can customize this high-level summary in your review settings.