branch-4.1:[fix](metric) Preserve labels for histogram metrics to fix wrong metric name for prometheus (#63485)#63716
Open
seawinde wants to merge 1 commit into
Open
Conversation
…ic name for prometheus (apache#63485) Related PR: apache#13832 Problem Summary: Histogram metrics that encode labels in the Dropwizard metric name can be rendered incorrectly when label values contain dots or other special characters. For example, a user value like `qing.lu@lbk.one` can be split as part of the metric name instead of being kept as the `user` label. Root cause: In `PrometheusMetricVisitor.visitHistogram()` and `JsonMetricVisitor.visitHistogram()`, the legacy histogram export path splits the Dropwizard histogram name by dots and infers labels from `k=v` name segments. `MetricRepo.USER_HISTO_QUERY_LATENCY` previously embedded the user label into the histogram name, so dots inside user names were treated as metric-name separators. Change Summary: | File | Change Description | |------|--------------------| | `fe/fe-core/src/main/java/org/apache/doris/metric/HistogramMetric.java` | Add a small wrapper that keeps the Dropwizard `Histogram` together with its metric name and structured labels. | | `fe/fe-core/src/main/java/org/apache/doris/metric/MetricRepo.java` | Export labeled histogram metrics through the new structured label path while keeping existing static histograms exported. | | `fe/fe-core/src/main/java/org/apache/doris/metric/CloudMetrics.java` | Keep cloud query latency and meta-service RPC latency labels structured instead of encoding them in histogram names. | | `fe/fe-core/src/main/java/org/apache/doris/metric/MetricVisitor.java` | Add a labeled histogram visit overload. | | `fe/fe-core/src/main/java/org/apache/doris/metric/PrometheusMetricVisitor.java` | Render structured histogram labels directly in Prometheus output. | | `fe/fe-core/src/main/java/org/apache/doris/metric/JsonMetricVisitor.java` | Render structured histogram labels directly in JSON output. | | `fe/fe-core/src/test/java/org/apache/doris/metric/MetricsTest.java` | Cover user and cloud histogram labels containing dots and at signs. | Design Rationale: The fix follows the existing counter and gauge approach: keep metric names stable and carry dimensions as `MetricLabel` values. The legacy three-argument histogram visitor remains for existing static Dropwizard histograms without labels, while dynamic histograms that need labels use the structured four-argument path. ```mermaid graph TD A["Query finished"] --> B["Update query metrics"] B --> C["Get or create per-user histogram"] C --> D["HistogramMetric stores name, histogram, and labels"] D --> E["MetricRepo visits histogram metrics"] E --> F["Prometheus or JSON visitor renders output"] F --> G["Stable metric name with structured labels"] ``` Fixed an issue where FE histogram metrics with label values containing dots, such as user names or cloud cluster names, could be exported with malformed metric names or labels. --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
|
Thank you for your contribution to Apache Doris. Please clearly describe your PR:
|
Member
Author
|
run buildall |
Contributor
FE Regression Coverage ReportIncrement line coverage |
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.
pr: #63485
commitId: 01241a9