Skip to content

out_chronicle: Add descriptions for label and namespace mappings#2582

Open
cosmo0920 wants to merge 1 commit into
masterfrom
cosmo0920-chronicle-namespace-mapping
Open

out_chronicle: Add descriptions for label and namespace mappings#2582
cosmo0920 wants to merge 1 commit into
masterfrom
cosmo0920-chronicle-namespace-mapping

Conversation

@cosmo0920
Copy link
Copy Markdown
Contributor

@cosmo0920 cosmo0920 commented May 22, 2026

Corresponding PR is: fluent/fluent-bit#11836.

Summary by CodeRabbit

  • Documentation
    • Expanded Google Chronicle output plugin documentation with new configuration parameters for enhanced label and namespace management.
    • Added practical examples demonstrating namespace fallback handling, record-based namespace resolution, and label configuration in both YAML and Fluent Bit formats.

Review Change Stack

Signed-off-by: Hiroshi Hatake <hiroshi@chronosphere.io>
@cosmo0920 cosmo0920 requested review from a team and eschabell as code owners May 22, 2026 06:31
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 22, 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: f544c32b-86b2-41f6-95a4-6803f39873e9

📥 Commits

Reviewing files that changed from the base of the PR and between d3d0a7a and 3a17b3b.

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

📝 Walkthrough

Walkthrough

Documentation for the Google Chronicle output plugin is expanded with new configuration parameters and practical usage examples. The configuration table now includes label, namespace, and namespace_key options, followed by a new section with YAML and Fluent Bit format examples showing namespace resolution and label attachment patterns.

Changes

Chronicle Output Configuration Documentation

Layer / File(s) Summary
Configuration parameter reference table
pipeline/outputs/chronicle.md
Configuration parameters table extended with new label (repeatable), namespace, and namespace_key entries to document Chronicle batching controls.
Namespace resolution and label usage examples
pipeline/outputs/chronicle.md
Added documentation section with YAML and Fluent Bit config examples demonstrating fallback namespace configuration, namespace_key-based namespace resolution from records, and attachment of both static and record-derived labels to Chronicle output batches.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2419: Both PRs modify pipeline/outputs/chronicle.md's configuration parameters table and related Chronicle examples, with direct content overlap in the same documentation file.

Suggested labels

5.0

Suggested reviewers

  • eschabell
  • patrick-stephens

Poem

🐰 A Chronicle of new ways to name,
Labels and namespaces stake their claim,
With examples bright in YAML's embrace,
Fluent Bit docs find their rightful place!
Configuration blooms, both static and free,
Documentation hops—as it ought to be! 🌿

🚥 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 title clearly and concisely describes the main change: adding documentation for label and namespace mappings in the Chronicle 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 cosmo0920-chronicle-namespace-mapping

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

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

namespace: fallback-namespace
namespace_key: $tenant_namespace
label: env production
label: cluster_name $cluster['name']
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably should always quote yaml strings because it can cause YAML specific formatting failures.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants