Conversation
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
Signed-off-by: Eduardo Silva <eduardo@chronosphere.io>
WalkthroughIntroduces a new KV API function flb_kv_item_set for update-or-insert behavior, updates the OpenTelemetry output plugin to use it for labels, and adds corresponding unit tests and build integration to prevent duplicate label keys. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor User as User config
participant OTel as OpenTelemetry plugin (config_add_labels)
participant KV as flb_kv_item_set
participant List as KV List
User->>OTel: add_label entries
loop For each label (k, v)
OTel->>KV: flb_kv_item_set(List, k, v)
KV->>List: Scan for key k (case-insensitive)
alt Key exists
KV->>List: Replace value for k
KV-->>OTel: Return kv item
else Key not found
KV->>List: Create new kv item (k, v)
KV-->>OTel: Return kv item
end
alt Allocation error
KV-->>OTel: Return NULL
OTel->>OTel: Log error, abort with -1
end
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing touches
🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
include/fluent-bit/flb_kv.h (1)
39-40: Clarify API semantics (case-insensitive match, NULL/empty value) and future-proof signature.Document that matching is case-insensitive and define behavior when v_buf is NULL or empty. Optionally add const qualifiers later (kept out here to avoid wider churn).
struct flb_kv *flb_kv_item_create(struct mk_list *list, char *k_buf, char *v_buf); -struct flb_kv *flb_kv_item_set(struct mk_list *list, - char *k_buf, char *v_buf); +/* Upsert key/value into list: + * - Key match is case-insensitive. + * - If v_buf is NULL or empty, the value is unset (kv->val == NULL). + * - Returns existing/new item on success; NULL on allocation failure (no removal). + */ +struct flb_kv *flb_kv_item_set(struct mk_list *list, + char *k_buf, char *v_buf);plugins/out_opentelemetry/opentelemetry_conf.c (1)
170-174: Nit: adjust log text to reflect “set” (not “append”).Small UX polish for clarity.
- if (!kv) { - flb_plg_error(ins, "could not append label %s=%s\n", k->str, v->str); + if (!kv) { + flb_plg_error(ins, "could not set label %s=%s\n", k->str, v->str); return -1; }tests/internal/kv.c (1)
1-34: Add tests for NULL/empty value semantics and case-insensitive overwrite.Covers edge cases and guards against regressions.
@@ static void test_kv_item_set_duplicate() { @@ } +static void test_kv_item_set_null_and_empty() +{ + struct mk_list list; + const char *val; + + flb_kv_init(&list); + + /* NULL value -> unset (kv->val == NULL) */ + TEST_CHECK(flb_kv_item_set(&list, "mode", NULL) != NULL); + TEST_CHECK(mk_list_size(&list) == 1); + val = flb_kv_get_key_value("mode", &list); + TEST_CHECK(val == NULL); + + /* Non-empty value */ + TEST_CHECK(flb_kv_item_set(&list, "mode", "on") != NULL); + val = flb_kv_get_key_value("mode", &list); + TEST_CHECK(val != NULL && strcmp(val, "on") == 0); + + /* Empty string -> unset (kv->val == NULL) */ + TEST_CHECK(flb_kv_item_set(&list, "mode", "") != NULL); + val = flb_kv_get_key_value("mode", &list); + TEST_CHECK(val == NULL); + + flb_kv_release(&list); +} + +static void test_kv_item_set_case_insensitive() +{ + struct mk_list list; + const char *val; + + flb_kv_init(&list); + + TEST_CHECK(flb_kv_item_set(&list, "Color", "red") != NULL); + TEST_CHECK(flb_kv_item_set(&list, "color", "blue") != NULL); + + TEST_CHECK(mk_list_size(&list) == 1); + val = flb_kv_get_key_value("COLOR", &list); + TEST_CHECK(val != NULL && strcmp(val, "blue") == 0); + + flb_kv_release(&list); +} @@ TEST_LIST = { {"kv_item_set_duplicate", test_kv_item_set_duplicate}, + {"kv_item_set_null_and_empty", test_kv_item_set_null_and_empty}, + {"kv_item_set_case_insensitive", test_kv_item_set_case_insensitive}, {0} };src/flb_kv.c (1)
79-107: Optional: pre-check length to avoid full strcasecmp on mismatched keys.Micro-optimization in long lists; not critical.
- if (strcasecmp(kv->key, k_buf) == 0) { + if (flb_sds_len(kv->key) == (v_buf ? strlen(k_buf) : strlen(k_buf)) && + strcasecmp(kv->key, k_buf) == 0) {
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
include/fluent-bit/flb_kv.h(1 hunks)plugins/out_opentelemetry/opentelemetry_conf.c(1 hunks)src/flb_kv.c(1 hunks)tests/internal/CMakeLists.txt(1 hunks)tests/internal/kv.c(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (4)
tests/internal/kv.c (1)
src/flb_kv.c (4)
flb_kv_init(25-28)flb_kv_item_set(79-107)flb_kv_get_key_value(135-162)flb_kv_release(123-133)
include/fluent-bit/flb_kv.h (1)
src/flb_kv.c (1)
flb_kv_item_set(79-107)
plugins/out_opentelemetry/opentelemetry_conf.c (1)
src/flb_kv.c (1)
flb_kv_item_set(79-107)
src/flb_kv.c (2)
src/flb_sds.c (2)
flb_sds_destroy(389-399)flb_sds_create(78-90)include/fluent-bit/flb_mem.h (1)
flb_free(126-128)
⏰ 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). (29)
- 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 (-DFLB_SANITIZE_THREAD=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_MEMORY=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 (-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 (-DFLB_ARROW=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_SIMD=On, 3.31.6, gcc, g++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=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_JEMALLOC=Off, 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 (-DSANITIZE_ADDRESS=On, 3.31.6, clang, clang++)
- GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
- 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-22.04, clang-12)
- GitHub Check: PR - fuzzing test
- 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-centos-7
🔇 Additional comments (3)
tests/internal/CMakeLists.txt (1)
13-13: Test wiring LGTM.Adding kv.c to internal tests is correct.
plugins/out_opentelemetry/opentelemetry_conf.c (1)
155-175: Behavioral check: dedupe is last-wins and preserves item order. OK for OTLP?Using flb_kv_item_set ensures uniqueness with last value winning; the existing node is updated in place (order preserved). Confirm this matches OpenTelemetry expectations for attributes added via add_label.
src/flb_kv.c (1)
61-77: Consistency note: create() treats empty value as unset (NULL).The patch above aligns set() to the same rule. If you intentionally want empty strings stored, we can switch to creating zero-length SDS and update tests accordingly.
Comment on lines
+89
to
+107
| mk_list_foreach(head, list) { | ||
| kv = mk_list_entry(head, struct flb_kv, _head); | ||
| if (strcasecmp(kv->key, k_buf) == 0) { | ||
| if (kv->val) { | ||
| flb_sds_destroy(kv->val); | ||
| } | ||
| kv->val = flb_sds_create(v_buf); | ||
| if (!kv->val) { | ||
| mk_list_del(&kv->_head); | ||
| flb_sds_destroy(kv->key); | ||
| flb_free(kv); | ||
| return NULL; | ||
| } | ||
| return kv; | ||
| } | ||
| } | ||
|
|
||
| return flb_kv_item_create(list, k_buf, v_buf); | ||
| } |
There was a problem hiding this comment.
Don’t delete existing entry on allocation failure; align empty/NULL value semantics.
Current code destroys the old value and removes the entire kv on failure to allocate the new value, causing data loss. Also, it creates an empty SDS for NULL/empty values, diverging from create() semantics (which leave kv->val == NULL). Fix both.
struct flb_kv *flb_kv_item_set(struct mk_list *list,
char *k_buf, char *v_buf)
{
- struct mk_list *head;
- struct flb_kv *kv;
-
- if (!k_buf) {
- return NULL;
- }
-
- mk_list_foreach(head, list) {
- kv = mk_list_entry(head, struct flb_kv, _head);
- if (strcasecmp(kv->key, k_buf) == 0) {
- if (kv->val) {
- flb_sds_destroy(kv->val);
- }
- kv->val = flb_sds_create(v_buf);
- if (!kv->val) {
- mk_list_del(&kv->_head);
- flb_sds_destroy(kv->key);
- flb_free(kv);
- return NULL;
- }
- return kv;
- }
- }
-
- return flb_kv_item_create(list, k_buf, v_buf);
+ struct mk_list *head;
+ struct flb_kv *kv;
+ size_t v_len = 0;
+ flb_sds_t new_val = NULL;
+
+ if (!k_buf) {
+ return NULL;
+ }
+ if (v_buf != NULL) {
+ v_len = strlen(v_buf);
+ }
+
+ mk_list_foreach(head, list) {
+ kv = mk_list_entry(head, struct flb_kv, _head);
+ if (strcasecmp(kv->key, k_buf) == 0) {
+ /* Empty/NULL => unset value (kv->val == NULL), keep entry */
+ if (v_len == 0) {
+ if (kv->val) {
+ flb_sds_destroy(kv->val);
+ kv->val = NULL;
+ }
+ return kv;
+ }
+ /* Allocate new first; preserve old on failure */
+ new_val = flb_sds_create_len(v_buf, v_len);
+ if (!new_val) {
+ return NULL;
+ }
+ if (kv->val) {
+ flb_sds_destroy(kv->val);
+ }
+ kv->val = new_val;
+ return kv;
+ }
+ }
+
+ /* Not found: creation already handles NULL/empty values */
+ return flb_kv_item_create(list, k_buf, v_buf);
}📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| mk_list_foreach(head, list) { | |
| kv = mk_list_entry(head, struct flb_kv, _head); | |
| if (strcasecmp(kv->key, k_buf) == 0) { | |
| if (kv->val) { | |
| flb_sds_destroy(kv->val); | |
| } | |
| kv->val = flb_sds_create(v_buf); | |
| if (!kv->val) { | |
| mk_list_del(&kv->_head); | |
| flb_sds_destroy(kv->key); | |
| flb_free(kv); | |
| return NULL; | |
| } | |
| return kv; | |
| } | |
| } | |
| return flb_kv_item_create(list, k_buf, v_buf); | |
| } | |
| struct flb_kv *flb_kv_item_set(struct mk_list *list, | |
| char *k_buf, char *v_buf) | |
| { | |
| struct mk_list *head; | |
| struct flb_kv *kv; | |
| size_t v_len = 0; | |
| flb_sds_t new_val = NULL; | |
| if (!k_buf) { | |
| return NULL; | |
| } | |
| if (v_buf != NULL) { | |
| v_len = strlen(v_buf); | |
| } | |
| mk_list_foreach(head, list) { | |
| kv = mk_list_entry(head, struct flb_kv, _head); | |
| if (strcasecmp(kv->key, k_buf) == 0) { | |
| /* Empty/NULL => unset value (kv->val == NULL), keep entry */ | |
| if (v_len == 0) { | |
| if (kv->val) { | |
| flb_sds_destroy(kv->val); | |
| kv->val = NULL; | |
| } | |
| return kv; | |
| } | |
| /* Allocate new first; preserve old on failure */ | |
| new_val = flb_sds_create_len(v_buf, v_len); | |
| if (!new_val) { | |
| return NULL; | |
| } | |
| if (kv->val) { | |
| flb_sds_destroy(kv->val); | |
| } | |
| kv->val = new_val; | |
| return kv; | |
| } | |
| } | |
| /* Not found: creation already handles NULL/empty values */ | |
| return flb_kv_item_create(list, k_buf, v_buf); | |
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #10866
This PR introduces a new upsert-style API for the kv interface. In addition we modify OpenTelemetry output plugin to use this new function when adding labels to avoid duplicates.
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