chore: Add future deprecation note for component_(sent|received)_bytes_total
metrics
#20412
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.
Vector originally published two component bytes metrics:
component_sent_bytes_total
the number of serialized bytes successfully sent by sinks (beforecompression)
component_received_bytes_total
the number of serialized bytes successfully received by sources(after decompression and filtering)
These were intended to be used by users to understand the volume of data flowing in/out of sources
and sinks. However, they were dependent on the exact serialization format such that the same event
going into the
socket
source vs.vector
source might be measured differently. To havea consistent metric we then added:
component_sent_event_bytes_total
the number of "estimated JSON event" bytes successfully sent by a componentscomponent_received_event_bytes_total
the number of "estimated JSON event" bytes successfully received by a componentsThis is a metric that is able to be compared between any two components. This removed a use-case of
component_(sent|received)_bytes_total
. The remaining use-case users seemed to use this metric forwas as a proxy for network bytes, but what they really are interested in is the actual network
bytes. So we proposed two new metrics:
component_sent_network_bytes_total
the total number of bytes sent out on the network by acomponent
component_received_network_bytes_total
the total number of bytes received on the network by acomponent
Once those metrics exist, it isn't clear what use-case remains for
component_(sent|received)_bytes_total
and so it would make sense to deprecate and remove them.Signed-off-by: Jesse Szwedko [email protected]