Skip to content

Conversation

@eschabell
Copy link
Collaborator

@eschabell eschabell commented Dec 2, 2025

All configuration parameters are now sorted alphabetically, and the classic .conf example follows the Title_Case convention used in other plugin docs.

Summary by CodeRabbit

  • Documentation
    • Updated GPU metrics configuration documentation with reorganized configuration keys.
    • Configuration keys now use CamelCase format in examples.
    • Added new configuration options: Path_Sysfs and Scrape_Interval.

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

…rs table and standardize classic config example. Fixes fluent#2258.

Signed-off-by: Eric D. Schabell <[email protected]>
@eschabell eschabell self-assigned this Dec 2, 2025
@eschabell eschabell requested review from a team as code owners December 2, 2025 10:06
@eschabell eschabell added the 4.2 label Dec 2, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 2, 2025

Walkthrough

Documentation update to the GPU metrics plugin configuration guide, including reordering of configuration keys in tables and examples, and converting configuration key names from snake_case to CamelCase format in code examples.

Changes

Cohort / File(s) Summary
GPU Metrics Documentation
pipeline/inputs/gpu-metrics.md
Updated configuration documentation tables and examples; reordered configuration key listings for consistency; converted fluent-bit.conf example keys from snake_case to CamelCase (Cards_Exclude, Cards_Include, Enable_Power, Enable_Temperature, Path_Sysfs, Scrape_Interval); reorganized fluent-bit.yaml example key positioning

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Verify CamelCase naming consistency across all configuration key examples
  • Ensure reordered keys maintain logical grouping and alignment with documentation descriptions
  • Check that all snake_case to CamelCase conversions are correctly applied

Possibly related issues

Poem

🐰 Configuration keys hop into place,
Snake_case becomes CamelCase with grace,
Tables reordered, examples aligned,
GPU metrics documented, refined,
Documentation dreams come true! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and specifically describes the main change: updating the gpu metrics input plugin documentation, updating the configuration parameters table, and standardizing the classic config example.
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 1d3edfc and 0ee2f77.

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

36-43: Confirm that path_sysfs and scrape_interval are documented plugin parameters.

The configuration table now includes two new parameters (path_sysfs and scrape_interval) at lines 42-43. These appear to have been added as part of the alphabetical reorganization, but need verification that they are:

  1. Actually supported by the gpu_metrics plugin
  2. Correctly documented with accurate descriptions and defaults

Please confirm these parameters exist in the plugin source and that the descriptions/defaults provided are accurate.


17-18: Resolve inconsistency between parameter name casing in documentation text and .conf example.

The documentation prose refers to parameters in lowercase (enable_power, enable_temperature), while the .conf example uses Title_Case (Enable_Power, Enable_Temperature). This inconsistency may confuse users about the correct parameter naming.

Once the .conf format is verified (see comment on lines 139-152), update the documentation prose to consistently reference parameters in the format they should be used.


139-152: No action required. The .conf configuration example correctly uses Title_Case format (e.g., Cards_Exclude, Enable_Power, Path_Sysfs), which is the standard Fluent Bit .conf convention. All parameters (cards_exclude, cards_include, path_sysfs, scrape_interval) are documented GPU metrics plugin parameters. The accompanying YAML example properly uses snake_case, which is correct for YAML syntax. No inconsistency exists between documentation styles.

Likely an incorrect or invalid review comment.


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

AI review passed, merging.

@eschabell eschabell merged commit 47ab62f into fluent:master Dec 2, 2025
8 checks passed
@eschabell eschabell deleted the erics_in_gpu_metrics_fixes branch December 2, 2025 10:22
@eschabell eschabell added 4.2.1 and removed 4.2 labels Dec 3, 2025
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.

1 participant