Skip to content

in_node_exporter_metrics: add timex collector description #2579

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

Open
ngillen wants to merge 1 commit into
base: master
Choose a base branch
from
Open

in_node_exporter_metrics: add timex collector description #2579

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions pipeline/inputs/node-exporter-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ This helps with down-sampling when collecting metrics.
| `collector.textfile.scrape_interval` | The rate in seconds at which `textfile` metrics are collected from the host operating system. | `0` |
| `collector.thermalzone.scrape_interval` | The rate in seconds at which `thermal_zone` metrics are collected from the host operating system. | `0` |
| `collector.time.scrape_interval` | The rate in seconds at which `time` metrics are collected from the host operating system. | `0` |
| `collector.timex.scrape_interval` | The rate in seconds at which `timex` metrics are collected from the host operating system. | `0` |
| `collector.uname.scrape_interval` | The rate in seconds at which `uname` metrics are collected from the host operating system. | `0` |
| `collector.vmstat.scrape_interval` | The rate in seconds at which `vmstat` metrics are collected from the host operating system. | `0` |
| `diskstats.ignore_device_regex` | Specify the regular expression for the` diskstats` to prevent collection of/ignore. | `^(ram\|loop\|fd\|(h\|s\|v\|xv)d[a-z]\|nvme\\d+n\\d+p)\\d+$` |
Expand Down Expand Up @@ -100,6 +101,7 @@ The Version column specifies the Fluent Bit version where the collector is avail
| `textfile` | Exposes custom metrics from text files. Requires `collector.textfile.path` to be set. | Linux | 2.2.0 |
| `thermal_zone` | Exposes thermal statistics from `/sys/class/thermal/thermal_zone/*`. | Linux | 2.2.1 |
| `time` | Exposes the current system time. | Linux | 1.8 |
| `timex` | Exposes selected `adjtimex(2)` system call stats. | Linux | TBD |
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 21, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Replace placeholder version TBD with the actual Fluent Bit release version.

The table explicitly defines Version as the release where the collector is available, so TBD makes this row non-actionable for users.

📌 Suggested doc fix 
-| `timex`             | Exposes selected `adjtimex(2)` system call stats.                                                | Linux            | TBD     |
+| `timex`             | Exposes selected `adjtimex(2)` system call stats.                                                | Linux            | <fluent-bit-version> |
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pipeline/inputs/node-exporter-metrics.md` at line 104, Replace the
placeholder "TBD" in the Version column for the `timex` row with the actual
Fluent Bit release that introduced the timex collector (locate the
release/CHANGELOG and set the Version cell to that release string); update the
table row containing the `timex` entry so the Version column shows the concrete
release (e.g., "Fluent Bit vX.Y.Z") instead of "TBD".

Copy link
Copy Markdown
Author

@ngillen ngillen May 21, 2026

Choose a reason for hiding this comment

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

Should be replaced by maintainers when fluent-bit PR is merged.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot May 21, 2026

Choose a reason for hiding this comment

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

@ngillen, understood — that's a reasonable workflow for pre-merge documentation. The TBD serves as a clear signal that the version still needs to be backfilled once fluent-bit PR #11718 lands and a release version is cut.

Would you like me to open a follow-up GitHub issue to track updating the version once the upstream PR is merged? That way it won't get forgotten. I can also resolve this review comment now if you'd like, since the TBD is intentional at this stage.

🧠 Learnings used 
Learnt from: jinyongchoi
Repo: fluent/fluent-bit-docs PR: 2363
File: pipeline/inputs/blob.md:0-0
Timestamp: 2026-01-28T01:07:56.666Z
Learning: In Fluent Bit input plugin documentation under pipeline/inputs, use the 'thread.' prefix for ring buffer settings (not 'threaded.'). Examples: thread.ring_buffer.capacity, thread.ring_buffer.window, thread.ring_buffer.retry_limit. This applies across input plugins (e.g., tail, opentelemetry, prometheus-textfile, blob).

Learnt from: eschabell
Repo: fluent/fluent-bit-docs PR: 2386
File: about/fluentd-and-fluent-bit.md:13-13
Timestamp: 2026-02-26T19:25:08.913Z
Learning: In the fluent-bit-docs repository, ensure all Markdown documentation remains technical and neutral. Do not include marketing-style content or promotional links, even when citing statistics. Prefer objective explanations, verifiable sources, and avoid promotional language across all .md files.

Learnt from: eschabell
Repo: fluent/fluent-bit-docs PR: 2410
File: pipeline/filters/throttle.md:11-14
Timestamp: 2026-03-10T21:24:13.706Z
Learning: In the fluent-bit-docs repository, continue to follow the documented convention: classic fluent-bit.conf examples use Title_Case for plugin-specific keys (e.g., Rate, Window, Interval, Name, Match), YAML fluent-bit.yaml examples use snake_case lowercase keys (e.g., rate, window, interval). Parameter tables should document the canonical lowercase key names. This is an intentional convention and should not be flagged as an inconsistency.

Copy link
Copy Markdown
Collaborator

@eschabell eschabell May 22, 2026

Choose a reason for hiding this comment

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

@ngillen not a worry here, just need to leave my review open with a request to change this line before merging, so will mark as waiting on review and code merge. No action needed by you.

| `uname` | Exposes system information as provided by the `uname` system call. | Linux, macOS | 1.8 |
| `vmstat` | Exposes statistics from `/proc/vmstat`. | Linux | 1.8.2 |

Expand Down
Loading