enhancement(observability): Standardize buffer size metric names#24493
Merged
enhancement(observability): Standardize buffer size metric names#24493
Conversation
bruceg
added
the
type: enhancement
bruceg
added
domain: observability
github-actions
bot
added
domain: external docs
jszwedko
reviewed
Jan 13, 2026
jszwedko
reviewed
Jan 13, 2026
bruceg
force-pushed
the
bruceg/standardize-buffer-metric-names
branch
from
85328e6 to
b048ffd
Compare
buraizu
approved these changes
Jan 14, 2026
Many of the buffer size metric names have been specified (in `docs/specs/buffer.md`) in a way that conflicts with the metric naming specification (in `docs/specs/instrumentation.md`). In particular, the latter specifies that metric names should end with a unit (ex `_bytes` or `_events`) but the former placed the units within the name (ex `buffer_byte_size` or `buffer_max_event_size`). This latter leads to a confusing metric name which seems to report the maximum event size that may be buffered while in reality it is reporting the maximum size of the buffer in terms of events. This change adds parallel metrics for these names that provide the standardized names. The existing names are thus deprecated and will be removed in a future version.
bruceg
force-pushed
the
bruceg/standardize-buffer-metric-names
branch
from
b048ffd to
5bf5a93
Compare
bruceg
commented
Jan 14, 2026
jszwedko
approved these changes
Jan 14, 2026
1 task
thomasqueirozb
approved these changes
Jan 16, 2026
Contributor
thomasqueirozb
left a comment
thomasqueirozb
left a comment
There was a problem hiding this comment.
LGTM! Website renders nicely too and I pushed a commit to add links to the new metrics
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 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
Many of the buffer size metric names have been specified (in
docs/specs/buffer.md) in a way that conflicts with the metric naming specification (indocs/specs/instrumentation.md). In particular, the latter specifies that metric names should end with a unit (ex_bytesor_events) but the former placed the units within the name (exbuffer_byte_sizeorbuffer_max_event_size). This latter leads to a confusing metric name which seems to report the maximum event size that may be buffered while in reality it is reporting the maximum size of the buffer in terms of events.This change adds parallel metrics for these names that provide the standardized names. The existing names are thus deprecated and will be removed in a future version.
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 here.