Skip to content

pipeline: outputs: logdna: add docs for exclude_promoted_keys#2560

Open
lecaros wants to merge 2 commits intomasterfrom
lecaros-add-logdna-feature
Open

pipeline: outputs: logdna: add docs for exclude_promoted_keys#2560
lecaros wants to merge 2 commits intomasterfrom
lecaros-add-logdna-feature

Conversation

@lecaros
Copy link
Copy Markdown
Contributor

@lecaros lecaros commented Apr 30, 2026

Adds documentation for PR fluent/fluent-bit#11755

Summary by CodeRabbit

  • Documentation
    • Added docs for the new exclude_promoted_keys option for LogDNA output: when enabled, promoted fields are removed from the JSON body while remaining available as top-level attributes.
    • Added an “Exclude promoted keys” section with before/after JSON examples and YAML/CONF configuration snippets.
    • Corrected wording in the record-enrichment table and added clarification about promoted keys' default behavior.

@lecaros lecaros requested review from a team and eschabell as code owners April 30, 2026 16:12
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 30, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 534908f3-1ec8-4e51-82ca-ee0d44887d69

📥 Commits

Reviewing files that changed from the base of the PR and between c368463 and ad13d51.

📒 Files selected for processing (1)
  • pipeline/outputs/logdna.md
✅ Files skipped from review due to trivial changes (1)
  • pipeline/outputs/logdna.md

📝 Walkthrough

Walkthrough

Documents a new exclude_promoted_keys option for the LogDNA output that, when true, removes promoted fields from the line JSON body while still sending them as top-level attributes. Includes before/after line examples and YAML/CONF config snippets.

Changes

LogDNA Output Documentation

Layer / File(s) Summary
Configuration Declaration
pipeline/outputs/logdna.md
Adds exclude_promoted_keys option to the configuration parameters table and documents default (false) and purpose (remove promoted keys from line to avoid duplication).
Explanatory Text
pipeline/outputs/logdna.md
Clarifies that discovered promoted keys are lifted to top-level line fields and explains default duplication behavior and how exclude_promoted_keys: true changes it. Also fixes wording ("describe" → "describes").
Examples / Usage
pipeline/outputs/logdna.md
Adds an “Exclude promoted keys” section with an input record and two resulting line JSON examples (default vs excluded), plus YAML and classic CONF snippets showing exclude_promoted_keys: true / Exclude_Promoted_Keys true.
Formatting / Minor Edits
pipeline/outputs/logdna.md
Reformats the classic fluent-bit.conf example indentation/line layout (no content changes).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I nibble docs with joyous cheer,

Promoted keys no longer duplicate here.
I tidy JSON, clear and bright,
Examples gleam in morning light.
Hooray — the docs hop into sight!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title clearly and specifically describes the main change: adding documentation for the exclude_promoted_keys feature in the LogDNA output plugin.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch lecaros-add-logdna-feature

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
Review rate limit: 0/1 reviews remaining, refill in 60 minutes.

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a 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

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pipeline/outputs/logdna.md`:
- Around line 175-179: The fluent-bit.conf example uses lowercase keys (name,
match, api_key, hostname, exclude_promoted_keys); change them to Title_Case to
match repo convention (e.g., Name, Match, Api_Key, Hostname,
Exclude_Promoted_Keys) so the example is consistent with other classic config
snippets.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d52948bd-7044-4c9b-af7e-328e601e40bb

📥 Commits

Reviewing files that changed from the base of the PR and between 53a72bd and c368463.

📒 Files selected for processing (1)
  • pipeline/outputs/logdna.md

Comment thread pipeline/outputs/logdna.md Outdated
Signed-off-by: lecaros <lecaros@chronosphere.io>
@lecaros lecaros force-pushed the lecaros-add-logdna-feature branch from c368463 to 2089a7d Compare April 30, 2026 16:16
@eschabell eschabell self-assigned this May 1, 2026
Comment thread pipeline/outputs/logdna.md
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners waiting-for-user Waiting for user/contributors feedback or requested changes labels May 1, 2026
Signed-off-by: lecaros <lecaros@chronosphere.io>
@lecaros lecaros removed the waiting-for-user Waiting for user/contributors feedback or requested changes label May 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

waiting-on-code-merge waiting-on-review Waiting on a review from mainteners

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants