Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Nov 28, 2025

Added two new config parameters and general updates to docker metrics input plugin doc. Fixes #2241.

Summary by CodeRabbit

  • Documentation
    • Enhanced Docker metrics documentation with significantly improved descriptions and restructured parameter information for greater clarity.
    • Added detailed configuration examples and Fluent Bit code samples to support practical deployment scenarios.
    • Included comprehensive guidance for configuring and managing multiple Docker instances efficiently.

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

.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
… input plugin doc. Fixes #2241.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Nov 28, 2025
@eschabell eschabell requested review from a team as code owners November 28, 2025 13:28
@eschabell eschabell added the 4.2 label Nov 28, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2025

Walkthrough

This pull request updates Docker metrics input plugin documentation by rewriting descriptions, reorganizing parameter tables into a new YAML-style format with lowercase keys, adding new configuration examples, and expanding the parameter field set. Additionally, two spelling exceptions are added to the Vale style configuration.

Changes

Cohort / File(s) Summary
Docker metrics documentation
pipeline/inputs/docker-metrics.md
Rewrote description for clarity; replaced single-column parameter table with multi-column YAML-style table using lowercase keys (exclude, include, interval_nsec, interval_sec, path.containers, path.sysfs, threaded); added new configuration example block and Fluent Bit configuration sample; removed old uppercase parameter descriptions
Vale spelling exceptions
vale-styles/FluentBit/Spelling-exceptions.txt
Added two spelling exception entries: "cgroup" and "Sysfs"

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Review the documentation table restructuring and parameter description updates for accuracy and consistency
  • Verify that all parameter key changes (to lowercase) are correctly applied and documented
  • Confirm the new configuration examples are valid Fluent Bit syntax

Possibly related PRs

Suggested labels

waiting-on-review

Suggested reviewers

  • cnorris-cs
  • esmerel

Poem

🐰 A docker doc made bright and new,
With tables neat and spellings true,
Where cgroup hops and sysfs plays,
Configuration parameters shine these days!
✨ Hop hop, reviewed with care!

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 clearly summarizes the main changes: adding new config parameters and general updates to the Docker metrics input plugin documentation.
Linked Issues check ✅ Passed The PR addresses all objectives from issue #2241: adds new configuration parameters (exclude, include, interval_nsec, interval_sec, path.containers, path.sysfs, threaded) and performs general standardization updates to the Docker metrics documentation.
Out of Scope Changes check ✅ Passed All changes are within scope: documentation updates to Docker metrics plugin and spelling exception additions for technical terms (cgroup, Sysfs) directly related to the documentation changes.
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 61eec27 and 0627211.

📒 Files selected for processing (2)
  • pipeline/inputs/docker-metrics.md (1 hunks)
  • vale-styles/FluentBit/Spelling-exceptions.txt (2 hunks)
🔇 Additional comments (6)
vale-styles/FluentBit/Spelling-exceptions.txt (1)

26-26: Spelling exceptions correctly added and alphabetically sorted.

Both entries ("cgroup" and "Sysfs") are properly positioned in alphabetical order and support the documentation terminology introduced in the Docker metrics plugin doc updates.

Also applies to: 224-224

pipeline/inputs/docker-metrics.md (5)

3-3: Description is clear and informative.

The rewritten introductory text effectively conveys the plugin's purpose and key capabilities.


9-17: Verify parameter names and defaults match the Docker metrics plugin implementation.

The table introduces significant changes:

  • Parameter names changed from mixed-case to lowercase snake_case (e.g., Interval_Secinterval_sec)
  • Two new parameters added: interval_nsec and path.sysfs

These changes must align with the actual plugin's accepted configuration parameters and their defaults. Verify:

  1. Do all parameter names (especially capitalization) match the plugin's expected input?
  2. Are interval_nsec and path.sysfs actually supported parameters?
  3. Is the interval_nsec default of 0 correct (meaning not set vs. unlimited polling)?
  4. Is the path.sysfs default of /sys/fs/cgroup appropriate across different environments?

If parameter names in the plugin differ from documentation, existing user configurations could break.


19-19: Helpful clarification of default behavior.

The explanation of behavior when neither include nor exclude is set makes the configuration options more understandable for users.


23-53: Verify configuration format syntax across both YAML and fluent-bit.conf styles.

The examples show different capitalization between formats: YAML uses lowercase include while fluent-bit.conf uses capitalized Include. Confirm:

  1. Does fluent-bit.conf format require capitalized parameter names like Include, or should it be lowercase include?
  2. Will both configuration styles work exactly as shown?

If the actual plugin expects case-insensitive parameter matching or if fluent-bit.conf parsing requires different syntax, these examples could mislead users.


57-59: Example output is clear and accurate.

The output sample effectively demonstrates the metric format and field names users can expect to receive from the Docker input plugin.


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

@coderabbitai review

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2025

✅ Actions performed

Review triggered.

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
Copy link
Collaborator Author

AI review passed, merging.

@eschabell eschabell merged commit 7f3d35f into fluent:master Nov 28, 2025
8 checks passed
@eschabell eschabell deleted the erics_docker_metrics_config_fixes branch November 28, 2025 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker metrics input plugin doc missing parameters and update.

1 participant