docs: administration: document logs tag records telemetry metrics by eschabell · Pull Request #2655 · fluent/fluent-bit-docs

eschabell · 2026-08-04T07:27:40Z

Document the service-level telemetry.metrics.logs.tag_records block, its per-input enabled override, and the two metrics it exposes:

service-section.md: add a Telemetry configuration section covering enabled, max_series, and max_tag_length, and note that the block is YAML-only with no dotted-key or classic-mode form.
pipeline-section.md: document the per-input enabled override and that the limits are service-level only.
monitoring.md: add fluentbit_input_logs_tag_records_total and fluentbit_input_logs_tag_records_untracked_total, including the max_series, tag_length_limit, and error reason labels.

Summary by CodeRabbit

Documentation
- Added guidance for configuring per-input log record counting by tag.
- Documented service-wide telemetry settings, cardinality limits, tag-length restrictions, and startup validation.
- Added YAML configuration examples, including disabling tracking for high-cardinality inputs.
- Documented metrics for ingested records by tag and records that could not be tracked, including cardinality and tag-length failure reasons.

coderabbitai · 2026-08-04T07:28:00Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d517daca-206c-4b3f-8a1f-9da633580cf4

📥 Commits

Reviewing files that changed from the base of the PR and between f60d18c and 69be352.

📒 Files selected for processing (3)

administration/configuring-fluent-bit/yaml/pipeline-section.md
administration/configuring-fluent-bit/yaml/service-section.md
administration/monitoring.md

🚧 Files skipped from review as they are similar to previous changes (3)

administration/configuring-fluent-bit/yaml/service-section.md
administration/monitoring.md
administration/configuring-fluent-bit/yaml/pipeline-section.md

📝 Walkthrough

Walkthrough

The documentation describes service and input configuration for per-tag log record metrics. It also documents tracked and untracked input metrics, their labels, cardinality limits, validation rules, and configuration requirements.

Changes

Telemetry metrics documentation

Layer / File(s)	Summary
Telemetry configuration and input overrides `administration/configuring-fluent-bit/yaml/service-section.md`, `administration/configuring-fluent-bit/yaml/pipeline-section.md`	Documents service telemetry settings, input overrides, validation rules, limits, inheritance, and YAML examples.
Per-tag monitoring metrics `administration/monitoring.md`	Documents tracked and untracked per-tag input log record metrics, labels, failure reasons, and configuration requirements.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: 5.0

Suggested reviewers: patrick-stephens, cosmo0920

🚥 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 documentation change for logs tag records telemetry metrics.
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.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

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

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@administration/configuring-fluent-bit/yaml/service-section.md`:
- Around line 51-59: Update the `max_series` and `max_tag_length` entries in the
`telemetry.metrics.logs.tag_records` configuration table to document their
accepted type, minimum value, and startup behavior for invalid values, including
the existing `0` sentinel semantics. State the exact validation rules for both
numeric limits and preserve the current defaults and descriptions.

🪄 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 Plus

Run ID: a8c5a4f3-4996-449b-a626-8c8c48f39d36

📥 Commits

Reviewing files that changed from the base of the PR and between 4a9a22b and d2089e2.

📒 Files selected for processing (3)

administration/configuring-fluent-bit/yaml/pipeline-section.md
administration/configuring-fluent-bit/yaml/service-section.md
administration/monitoring.md

eschabell · 2026-08-04T08:52:45Z

@coderabbitai review

coderabbitai · 2026-08-04T08:54:51Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

eschabell · 2026-08-04T09:12:50Z

@patrick-stephens ready for review!

Document the service-level telemetry.metrics.logs.tag_records block, its per-input enabled override, and the two metrics it exposes: - service-section.md: add a Telemetry configuration section covering enabled, max_series, and max_tag_length, and note that the block is YAML-only with no dotted-key or classic-mode form. - pipeline-section.md: document the per-input enabled override and that the limits are service-level only. - monitoring.md: add fluentbit_input_logs_tag_records_total and fluentbit_input_logs_tag_records_untracked_total, including the max_series, tag_length_limit, and error reason labels. Signed-off-by: Eric D. Schabell <eric@schabell.org>

The max_series and max_tag_length rows documented the 0 sentinel but not the accepted types or what happens on a bad value. - Note that both limits accept an integer or an integer-only string, that strings are environment-variable expanded, and that the value must fit in a signed 32-bit integer. - Document that unparsable or out-of-range values fail at startup. - Correct the sentinel: 0 or less removes the limit. Neither limit enforces a minimum, so negative values are accepted rather than rejected. Signed-off-by: Eric D. Schabell <eric@schabell.org>

coderabbitai · 2026-08-05T12:30:46Z

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

) * docs: administration: document logs tag records telemetry metrics Document the service-level telemetry.metrics.logs.tag_records block, its per-input enabled override, and the two metrics it exposes: - service-section.md: add a Telemetry configuration section covering enabled, max_series, and max_tag_length, and note that the block is YAML-only with no dotted-key or classic-mode form. - pipeline-section.md: document the per-input enabled override and that the limits are service-level only. - monitoring.md: add fluentbit_input_logs_tag_records_total and fluentbit_input_logs_tag_records_untracked_total, including the max_series, tag_length_limit, and error reason labels. Signed-off-by: Eric D. Schabell <eric@schabell.org> * docs: administration: yaml: document tag_records limit validation rules The max_series and max_tag_length rows documented the 0 sentinel but not the accepted types or what happens on a bad value. - Note that both limits accept an integer or an integer-only string, that strings are environment-variable expanded, and that the value must fit in a signed 32-bit integer. - Document that unparsable or out-of-range values fail at startup. - Correct the sentinel: 0 or less removes the limit. Neither limit enforces a minimum, so negative values are accepted rather than rejected. Signed-off-by: Eric D. Schabell <eric@schabell.org> --------- Signed-off-by: Eric D. Schabell <eric@schabell.org> Signed-off-by: Patrick Stephens <pat@telemetryforge.io>

eschabell requested a review from patrick-stephens August 4, 2026 07:27

eschabell self-assigned this Aug 4, 2026

eschabell requested a review from a team as a code owner August 4, 2026 07:27

eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Aug 4, 2026

coderabbitai Bot reviewed Aug 4, 2026

View reviewed changes

Comment thread administration/configuring-fluent-bit/yaml/service-section.md Outdated

patrick-stephens approved these changes Aug 5, 2026

View reviewed changes

eschabell removed the waiting-on-review Waiting on a review from mainteners label Aug 5, 2026

eschabell added 2 commits August 5, 2026 14:29

eschabell force-pushed the erics_tag_records_telemetry_metrics_updates branch from 2f909b3 to 69be352 Compare August 5, 2026 12:30

eschabell merged commit 8d994ab into fluent:master Aug 5, 2026
8 checks passed

eschabell deleted the erics_tag_records_telemetry_metrics_updates branch August 5, 2026 12:32

eschabell added 5.1 and removed 5.0.9 labels Aug 6, 2026

coderabbitai Bot mentioned this pull request Aug 9, 2026

docs: administration: document input rate metrics and rate gate #2637

Merged

Navigation Menu

Uh oh!

docs: administration: document logs tag records telemetry metrics - #2655

docs: administration: document logs tag records telemetry metrics#2655
eschabell merged 2 commits into
fluent:masterfrom
eschabell:erics_tag_records_telemetry_metrics_updates

eschabell commented Aug 4, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 4, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Uh oh!

Uh oh!

eschabell commented Aug 4, 2026

Uh oh!

coderabbitai Bot commented Aug 4, 2026 •

edited

Loading

Uh oh!

eschabell commented Aug 4, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

eschabell commented Aug 4, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

eschabell commented Aug 4, 2026

Uh oh!

coderabbitai Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

eschabell commented Aug 4, 2026

Uh oh!

coderabbitai Bot commented Aug 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

eschabell commented Aug 4, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 4, 2026 •

edited

Loading

coderabbitai Bot commented Aug 4, 2026 •

edited

Loading