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

[eschabell]

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

[coderabbitai]

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

• Adjusted config option table and cleanup of disk io metrics input plugin doc. Fixes #2235. #2236: Standardizes plugin configuration option names (e.g., Interval_Sec → interval_sec) and updates sample/config tables across input plugin docs.
• Updated exec input plugin doc config parameter table and general standardization. Fixes #2249. #2250: Standardizes input plugin configuration keys from CamelCase to snake_case (interval_sec, interval_nsec, threaded) across documentation.
• Fixed typos, sorted config table, moved a config option from metrics table. Fixes #2233 #2234: Makes same config-key renames (Interval_Sec→interval_sec, PID→pid) and standardizes threaded configuration in public config tables.

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[eschabell]

AI review passed, merging.