feat(metrics): Add per-component CPU usage metric#25185
Draft
gwenaskell wants to merge 3 commits intomasterfrom
Draft
feat(metrics): Add per-component CPU usage metric#25185gwenaskell wants to merge 3 commits intomasterfrom
gwenaskell wants to merge 3 commits intomasterfrom
Conversation
github-actions
bot
added
domain: topology
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| Operators use it exactly like `process_cpu_seconds_total` from the Prometheus | ||
| ecosystem: | ||
|
|
||
| ```promql |
| CPU, excluding preemption, involuntary context switches, and any time another | ||
| process used the core. | ||
|
|
||
| **Linux and macOS — `clock_gettime(CLOCK_THREAD_CPUTIME_ID)`** |
| ```rust | ||
| #[cfg(any(target_os = "linux", target_os = "macos"))] | ||
| fn thread_cpu_time() -> Duration { | ||
| let mut ts = libc::timespec { tv_sec: 0, tv_nsec: 0 }; |
| #[cfg(any(target_os = "linux", target_os = "macos"))] | ||
| fn thread_cpu_time() -> Duration { | ||
| let mut ts = libc::timespec { tv_sec: 0, tv_nsec: 0 }; | ||
| // SAFETY: ts is a valid pointer to a timespec struct and |
| // CLOCK_THREAD_CPUTIME_ID is a valid clock id on Linux >= 2.6 | ||
| // and macOS >= 10.12. | ||
| unsafe { | ||
| libc::clock_gettime(libc::CLOCK_THREAD_CPUTIME_ID, &mut ts); |
| poll, the delta between two calls around `transform_all` gives exact CPU time | ||
| consumed by that transform invocation. | ||
|
|
||
| **Overhead:** On Linux, `clock_gettime(CLOCK_THREAD_CPUTIME_ID)` is |
| ```rust | ||
| /// Returns the CPU time consumed by the calling thread. | ||
| /// | ||
| /// On Linux and macOS, uses clock_gettime(CLOCK_THREAD_CPUTIME_ID) (nanosecond precision). |
| CPU-bottlenecked vs. backpressure-limited, enabling informed tuning. | ||
| - **Composable with existing metrics.** `rate(cpu_seconds[1m])` gives CPU | ||
| cores used; dividing by `utilization` separates CPU from pipeline effects. | ||
| - **Low overhead.** Two `clock_gettime` calls per batch (~80ns total on Linux) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a new metric reporting the CPU time consumed by sync/function transforms, to get a better measurement of their CPU usage.
See the RFC for more details.
Vector configuration
How did you test this PR?
Change Type
Is this a breaking change?
Does this PR include user facing changes?
no-changeloglabel to this PR.References
Notes
@vectordotdev/vectorto reach out to us regarding this PR.pre-pushhook, please see this template.make fmtmake check-clippy(if there are failures it's possible some of them can be fixed withmake clippy-fix)make testgit merge origin masterandgit push.Cargo.lock), pleaserun
make build-licensesto regenerate the license inventory and commit the changes (if any). More details on the dd-rust-license-tool.