HostingMetrics: empty "http.route" tags shouldn't be present #62432
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.
HostingMetrics: empty "http.route" tags shouldn't be present
When pushing metrics to third-party softwares such as prometheus. Having empty-valued labels will cause issues
Description
Microsoft.AspNetCore.Hosting
create a metric calledhttp.server.request.duration
documented here: https://learn.microsoft.com/en-us/aspnet/core/log-mon/metrics/built-inOne the available labels is
http.route
which is optional.Issue:
http.route
can be populated with various string such as:And it can also be missing.
However, based on the OpenMetrics spec used by Prometheus, empty label values should be treated as if the label was not present.
That means when exporting data to prometheus, we currently create two different metrics (one for http_route= <empty string>, one for the missing http_route), which create a "duplicate sample for timestamp" error when importing data.
Fix:
To fix this issue, I changed the metric labelling so an empty route doesn't create the label, as if the variable was null.
Fixes #62431