Skip to content

pipeline: inputs: memory-metrics: update doc with metrics table, examples, and pid output #2281

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.

Sign up for GitHub

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

Jump to bottom
Merged
eschabell merged 1 commit into from
Dec 5, 2025
Merged

pipeline: inputs: memory-metrics: update doc with metrics table, examples, and pid output #2281

eschabell merged 1 commit into from
Dec 5, 2025

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Dec 5, 2025 •
edited by coderabbitai bot
Loading

Added metrics table, example usage, config parameter table, and more.

Fixes #2280.

Summary by CodeRabbit

  • Documentation
    • Enhanced memory-metrics documentation with expanded tables for metrics (including memory and swap fields) and configuration parameters
    • Improved configuration examples with clearer field formatting, default values, and sample blocks
    • Added concrete example output demonstrating metrics behavior with detailed field descriptions
    • Refined command-line instructions and wording for improved clarity and usability

✏️ Tip: You can customize this high-level summary in your review settings.

@eschabell
pipeline: inputs: memory-metrics: update doc with metrics table, exam…
6d179d6 
…ples, and pid output. Fixes fluent#2280.

Signed-off-by: Eric D. Schabell <[email protected]>
@eschabell eschabell self-assigned this Dec 5, 2025
@eschabell eschabell requested a review from a team as a code owner December 5, 2025 12:52
@eschabell eschabell added the 4.2.1 label Dec 5, 2025
@eschabell eschabell requested a review from a team as a code owner December 5, 2025 12:52
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 5, 2025 •
edited
Loading

Walkthrough

The memory-metrics input plugin documentation has been comprehensively updated with clarifications on Linux-specific behavior, a new metrics table documenting reported fields (Mem.free, Mem.total, Mem.used, Swap.*, proc_bytes, proc_hr), a configuration parameters table, and concrete example outputs showing pid-specific metrics collection.

Changes

Cohort / File(s) Summary
Documentation expansion
pipeline/inputs/memory-metrics.md		 Added metrics reported table, configuration parameters table with interval_nsec, interval_sec, pid, threaded options; clarified Linux-specific behavior; updated command-line examples; reintroduced and expanded fluent-bit.yaml and fluent-bit.conf configuration blocks; added concrete example output for pid-based metric collection with proc_bytes and proc_hr fields.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify that all metrics table entries (Mem.free, Mem.total, Mem.used, Swap.*, proc_bytes, proc_hr) match actual plugin output and have correct units.
  • Confirm configuration parameter defaults and descriptions in the config table are accurate.
  • Cross-check example YAML and conf block syntax against fluent-bit configuration standards.
  • Ensure example output JSON snippet reflects actual plugin behavior when pid is set.

Possibly related PRs

Poem

🐰 Hopping through metrics, tail held high,
Memory data now caught by the eye—
Tables and examples, so crisp and so clear,
Node Exporter's tales we all long to hear!
Config parameters in rows we embrace,
Documentation's found its perfect place! ✨

Pre-merge checks and finishing touches

✅ 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 accurately reflects the main changes: updated documentation with metrics table, configuration examples, and PID output information for memory-metrics input.
Linked Issues check ✅ Passed All objectives from issue #2280 are met: metrics table added, configuration parameter table included, example usage provided, and PID output documented.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation updates for the memory-metrics input plugin as required by issue #2280; no unrelated modifications detected.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between dc0465e and 6d179d6.

📒 Files selected for processing (1)
  • pipeline/inputs/memory-metrics.md (3 hunks)
🔇 Additional comments (1)
pipeline/inputs/memory-metrics.md (1)

1-97: Comprehensive documentation update that well addresses PR objectives.

The memory-metrics documentation has been significantly improved with clear structure, tables, and examples. The changes directly address all requirements from issue #2280:

  • ✓ Metrics table with units (lines 5-17)
  • ✓ Configuration parameters table with defaults (lines 18-27)
  • ✓ Example usage in both YAML and conf formats (lines 52-89)
  • ✓ PID output documentation with concrete example (lines 91-97)

The Linux-specific behavior is stated upfront (line 3), and the distinction between standard memory metrics and optional process-specific metrics is clear.

The metric field names, config parameter defaults, and example outputs should be verified against the actual fluent-bit mem plugin source code to confirm the documented values (interval_sec: 1, proc_bytes as RSS, metric field case sensitivity, etc.) match the plugin's implementation.

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.

@eschabell
Copy link
Collaborator Author

eschabell commented Dec 5, 2025

AI review passed, merging.

@eschabell eschabell merged commit b98e343 into fluent:master Dec 5, 2025
8 checks passed
@eschabell eschabell deleted the erics_in_memory_metrics_updates branch December 5, 2025 12:58
@coderabbitai coderabbitai bot mentioned this pull request Jan 15, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@eschabell eschabell

Labels

4.2.1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

pipeline: inputs: memory-metrics: update doc with metrics table, examples, and pid output

1 participant

@eschabell