Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

in_gpu_metrics: updated config parameters descriptions. #11237

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
Open
eschabell wants to merge 2 commits into
base: master
Choose a base branch
Loading
from
Open

in_gpu_metrics: updated config parameters descriptions. #11237

eschabell wants to merge 2 commits into from

Conversation

@eschabell
Copy link
Contributor

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

The following updates help make the config parameter descriptions more informative:

  • Sort configuration parameters alphabetically
  • Add detailed pattern format info to cards_include and cards_exclude (supports '*' for all, comma-separated IDs, and ranges like '0-2')
  • Add specific metric names to enable_power and enable_temperature
    • Standardize path_sysfs description to 'sysfs mount point'
  • Add trailing periods to descriptions for consistency

Fixes #11236.

Testing

  • [N/A ] Example configuration file for the change
  • [N/A ] Debug log output from testing the change
  • [N/A ] Attached Valgrind output that shows no leaks or memory corruption was found
  • [N/A ] Run local packaging test showing all targets (including any new ones) build.
  • [N/A ] Set ok-package-test label to test for all targets (requires maintainer to do).

Documentation

  • Documentation required for this feature

Doc update PR: fluent/fluent-bit-docs#2259

Backporting

  • [N/A ] Backport to latest stable release.

Fluent Bit is licensed under Apache 2.0, by submitting this pull request I understand that this code will be released under the terms of that license.

Summary by CodeRabbit

  • Documentation
    • Updated GPU metrics configuration docs: added GPU exclusion option (supports wildcards, comma-separated IDs, ranges), clarified inclusion semantics, and specified which metrics are collected for power and temperature.
    • Added documentation for configurable sysfs mount point and for the scrape interval controlling GPU metrics collection.

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

@eschabell
in_gpu_metrics: updated config parameters descriptions.
c27aea0 
- Sort configuration parameters alphabetically
- Add detailed pattern format info to cards_include and cards_exclude
  (supports '*' for all, comma-separated IDs, and ranges like '0-2')
- Add specific metric names to enable_power and enable_temperature
- - Standardize path_sysfs description to 'sysfs mount point'
- Add trailing periods to descriptions for consistency

Fixes fluent#11236.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@coderabbitai
Copy link

coderabbitai bot commented Dec 2, 2025 •
edited
Loading

Warning

Rate limit exceeded

@eschabell has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 6 minutes and 49 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 0e25a1f and 20fb465.

📒 Files selected for processing (1)
  • plugins/in_gpu_metrics/gpu_metrics.c (1 hunks)

Walkthrough

Updated the GPU metrics input plugin's configuration entries: added cards_exclude, path_sysfs, and scrape_interval; clarified and reworded cards_include, enable_power, and enable_temperature descriptions; reordered config map entries. No functional code or public API changes.

Changes

Cohort / File(s) Summary
GPU Metrics Configuration Updates
plugins/in_gpu_metrics/gpu_metrics.c		 Added cards_exclude, path_sysfs, and scrape_interval config entries; updated cards_include, enable_power, and enable_temperature descriptions; reordered configuration map entries. No logic or API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single file; only documentation/config-string updates.
  • No behavioral or API changes to validate.

Possibly related issues

Suggested reviewers

  • edsiper
  • cosmo0920
  • leonardo-albertovich

Poem

🐰
I nibbled through strings, made descriptions bright,
Cards excluded, included — now all just right.
Path to sysfs and intervals set true,
Metrics sing clearer — a rabbit's small review! 🥕

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 summarizes the main change: updating configuration parameter descriptions for the in_gpu_metrics plugin.
Linked Issues check ✅ Passed The pull request fully addresses issue #11236's objective to improve clarity and conciseness of in_gpu_metrics configuration parameter descriptions with informative help text.
Out of Scope Changes check ✅ Passed All changes are within scope: configuration parameter updates, descriptions, and documentation alignment directly address the linked issue requirements.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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.

coderabbitai[bot]
coderabbitai bot reviewed Dec 2, 2025
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 10ebd3a and c27aea0.

📒 Files selected for processing (1)
  • plugins/in_gpu_metrics/gpu_metrics.c (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (31)
  • GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit (Arm64), amd64_arm64, -DCMAKE_SYSTEM_NAME=Windows -DCMA...
  • GitHub Check: pr-windows-build / call-build-windows-package (Windows 64bit, x64, x64-windows-static, 3.31.6)
  • GitHub Check: pr-windows-build / call-build-windows-package (Windows 32bit, x86, x86-windows-static, 3.31.6)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_COMPILER_STRICT_POINTER_TYPES=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_THREAD=On, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=Off, 3.31.6, gcc, g++)
  • GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-24.04, clang-14)
  • GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_COVERAGE=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_ARROW=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SIMD=On, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SMALL=On, 3.31.6, clang, clang++)
  • GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-24.04, clang-14)
  • GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_UNDEFINED=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_SANITIZE_MEMORY=On, 3.31.6, gcc, g++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, clang, clang++)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=Off, 3.31.6, clang, clang++)
  • GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, clang, clang++, ubuntu-22.04, clang-12)
  • GitHub Check: run-ubuntu-unit-tests (-DFLB_JEMALLOC=On, 3.31.6, gcc, g++)
  • GitHub Check: pr-compile-system-libs (-DFLB_PREFER_SYSTEM_LIBS=On, 3.31.6, gcc, g++, ubuntu-22.04, clang-12)
  • GitHub Check: run-ubuntu-unit-tests (-DSANITIZE_ADDRESS=On, 3.31.6, clang, clang++)
  • GitHub Check: pr-compile-without-cxx (3.31.6)
  • GitHub Check: pr-compile-centos-7
  • GitHub Check: PR - fuzzing test
🔇 Additional comments (2)
plugins/in_gpu_metrics/gpu_metrics.c (2)

183-191: LGTM! Clear metric name references.

The descriptions correctly reference the specific metric names (gpu_power_watts and gpu_temperature_celsius) that match the gauge creation at lines 103-105 and 107-109. This helps users understand exactly which metrics are affected.

171-181: The pattern format descriptions are accurate and well-documented. The referenced formats—wildcards (*), comma-separated IDs (e.g., 0,1,2), and ranges (e.g., 0-2)—are all supported by the plugin according to official Fluent Bit documentation. The descriptions also correctly reflect the default values: cards_include defaults to "*" (all cards) and cards_exclude defaults to "" (none excluded). No issues found.

plugins/in_gpu_metrics/gpu_metrics.c Show resolved Hide resolved
@edsiper
Copy link
Member

edsiper commented Dec 3, 2025

let's cleanup the history of this PR (commits)

image

@eschabell
in_gpu_metrics: Added review comment fix.
20fb465 
Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell force-pushed the erics_in_gpu_metrics_updates branch from 0e25a1f to 20fb465 Compare December 4, 2025 09:12
@eschabell
Copy link
Contributor Author

eschabell commented Dec 4, 2025

@edsiper fixed commit messages.

@edsiper
Copy link
Member

edsiper commented Dec 5, 2025

@eschabell thanks for the updates. Looking at the current history of commits in this PR:

image

the last commit at bottom says "Added review comment fix" --> however this actually a fix for a change I asked before, its not related to a real code change, I think both commits can be squashed in one since the last one is not needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@cosmo0920 cosmo0920 cosmo0920 approved these changes

@edsiper edsiper Awaiting requested review from edsiper edsiper is a code owner

Assignees

No one assigned

Labels

docs-required

Projects

None yet

Milestone

Fluent Bit v5.0

Development

Successfully merging this pull request may close these issues.

in_gpu_metrics: updated config parameters descriptions

3 participants

@eschabell @edsiper @cosmo0920
Morty Proxy This is a proxified and sanitized view of the page, visit original site.