Support to return prometheus metrics with instance label #6864

turboFei · 2024-12-25T07:35:32Z

Why are the changes needed?

For my use case, the instances are not human readable, so I prefer to return the FQDN.

How was this patch tested?

Integration testing.

(base) ➜  dist git:(prometheus_label_2) cat conf/kyuubi-defaults.conf
kyuubi.metrics.prometheus.metrics.instance.enabled=true
kyuubi.zookeeper.embedded.client.port.address=localhost
kyuubi.frontend.bind.host=localhost

Was this patch authored or co-authored using generative AI tooling?

No.

kyuubi-metrics/src/main/scala/org/apache/kyuubi/metrics/MetricsConf.scala

pan3793 · 2024-12-25T08:31:42Z

kyuubi-metrics/src/main/scala/org/apache/kyuubi/metrics/PrometheusReporterService.scala

+        line
+      } else {
+        val Array(metrics, value) = line.split("\\s+", 2)
+        s"""$metrics${labelStr} $value"""


a little bit hacky, but given the feature is disabled by default, let's merge it in first.

changed to

line.split("\\s+", 2) match { case Array(metrics, rest) => s"""$metrics${labelStr} $rest""" case _ => line }

codecov-commenter · 2024-12-25T09:40:29Z

Codecov Report

Attention: Patch coverage is 0% with 33 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (d50cf17) to head (d24571c).
Report is 4 commits behind head on master.

Files with missing lines	Patch %	Lines
...che/kyuubi/metrics/PrometheusReporterService.scala	0.00%	28 Missing ⚠️
.../scala/org/apache/kyuubi/metrics/MetricsConf.scala	0.00%	5 Missing ⚠️

Additional details and impacted files

@@          Coverage Diff           @@
##           master   #6864   +/-   ##
======================================
  Coverage    0.00%   0.00%           
======================================
  Files         687     687           
  Lines       42473   42504   +31     
  Branches     5796    5798    +2     
======================================
- Misses      42473   42504   +31

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

For my use case, the instances are not human readable, so I prefer to return the FQDN. <img width="1483" alt="image" src="https://github.com/user-attachments/assets/92045517-456f-4087-8a36-9e3e4bea2f1d" /> Integration testing. ``` (base) ➜ dist git:(prometheus_label_2) cat conf/kyuubi-defaults.conf kyuubi.metrics.prometheus.metrics.instance.enabled=true kyuubi.zookeeper.embedded.client.port.address=localhost kyuubi.frontend.bind.host=localhost ``` <img width="1692" alt="image" src="https://github.com/user-attachments/assets/0b60d504-62ec-418d-880b-f8a2f00d5550" /> No. Closes #6864 from turboFei/prometheus_label_2. Closes #6864 d24571c [Wang, Fei] match 6a6a511 [Wang, Fei] comments c3046d4 [Wang, Fei] save fb2021a [Wang, Fei] revert 4239594 [Wang, Fei] compatible 17b7007 [Wang, Fei] add instance label Authored-by: Wang, Fei <[email protected]> Signed-off-by: Cheng Pan <[email protected]> (cherry picked from commit aa33521) Signed-off-by: Cheng Pan <[email protected]>

pan3793 · 2024-12-25T09:53:41Z

Thanks, merged to master/1.10

### Why are the changes needed? For histogram and timer metrics, it already has label, so need to support apply the instance label with existing ones. For example: ``` # HELP kyuubi_backend_service_close_operation Generated from Dropwizard metric import (metric=kyuubi.backend_service.close_operation, type=com.codahale.metrics.Timer) # TYPE kyuubi_backend_service_close_operation summary kyuubi_backend_service_close_operation{quantile="0.5",}{instance="hadoopkyuubi-1.hadoopkyuubihl.hadoopmaster-dev.svc.140.tess.io:10019"} 0.032923216000000005 ``` ### How was this patch tested? UT. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #6868 from turboFei/instance_label_follow. Closes #6864 4894784 [Wang, Fei] ut b8f227f [Wang, Fei] save Authored-by: Wang, Fei <[email protected]> Signed-off-by: Cheng Pan <[email protected]>

### Why are the changes needed? For histogram and timer metrics, it already has label, so need to support apply the instance label with existing ones. For example: ``` # HELP kyuubi_backend_service_close_operation Generated from Dropwizard metric import (metric=kyuubi.backend_service.close_operation, type=com.codahale.metrics.Timer) # TYPE kyuubi_backend_service_close_operation summary kyuubi_backend_service_close_operation{quantile="0.5",}{instance="hadoopkyuubi-1.hadoopkyuubihl.hadoopmaster-dev.svc.140.tess.io:10019"} 0.032923216000000005 ``` ### How was this patch tested? UT. ### Was this patch authored or co-authored using generative AI tooling? No. Closes #6868 from turboFei/instance_label_follow. Closes #6864 4894784 [Wang, Fei] ut b8f227f [Wang, Fei] save Authored-by: Wang, Fei <[email protected]> Signed-off-by: Cheng Pan <[email protected]> (cherry picked from commit fd53913) Signed-off-by: Cheng Pan <[email protected]>

…ce label ### Why are the changes needed? For my use case, the instances are not human readable, so I prefer to return the FQDN. <img width="1483" alt="image" src="https://github.com/user-attachments/assets/92045517-456f-4087-8a36-9e3e4bea2f1d" /> ### How was this patch tested? Integration testing. ``` (base) ➜ dist git:(prometheus_label_2) cat conf/kyuubi-defaults.conf kyuubi.metrics.prometheus.metrics.instance.enabled=true kyuubi.zookeeper.embedded.client.port.address=localhost kyuubi.frontend.bind.host=localhost ``` <img width="1692" alt="image" src="https://github.com/user-attachments/assets/0b60d504-62ec-418d-880b-f8a2f00d5550" /> ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#6864 from turboFei/prometheus_label_2. Closes apache#6864 d24571c [Wang, Fei] match 6a6a511 [Wang, Fei] comments c3046d4 [Wang, Fei] save fb2021a [Wang, Fei] revert 4239594 [Wang, Fei] compatible 17b7007 [Wang, Fei] add instance label Authored-by: Wang, Fei <[email protected]> Signed-off-by: Cheng Pan <[email protected]>

…g labels ### Why are the changes needed? For histogram and timer metrics, it already has label, so need to support apply the instance label with existing ones. For example: ``` # HELP kyuubi_backend_service_close_operation Generated from Dropwizard metric import (metric=kyuubi.backend_service.close_operation, type=com.codahale.metrics.Timer) # TYPE kyuubi_backend_service_close_operation summary kyuubi_backend_service_close_operation{quantile="0.5",}{instance="hadoopkyuubi-1.hadoopkyuubihl.hadoopmaster-dev.svc.140.tess.io:10019"} 0.032923216000000005 ``` ### How was this patch tested? UT. ### Was this patch authored or co-authored using generative AI tooling? No. Closes apache#6868 from turboFei/instance_label_follow. Closes apache#6864 4894784 [Wang, Fei] ut b8f227f [Wang, Fei] save Authored-by: Wang, Fei <[email protected]> Signed-off-by: Cheng Pan <[email protected]>

turboFei added 3 commits December 24, 2024 21:15

add instance label

17b7007

compatible

4239594

revert

fb2021a

github-actions bot added the module:metrics label Dec 25, 2024

save

c3046d4

turboFei force-pushed the prometheus_label_2 branch from fd4ae38 to c3046d4 Compare December 25, 2024 07:58

turboFei changed the title ~~Prometheus label 2~~ Support to return prometheus metrics with instance label Dec 25, 2024

turboFei requested a review from pan3793 December 25, 2024 08:13

pan3793 reviewed Dec 25, 2024

View reviewed changes

kyuubi-metrics/src/main/scala/org/apache/kyuubi/metrics/MetricsConf.scala Outdated Show resolved Hide resolved

github-actions bot added the kind:documentation Documentation is a feature! label Dec 25, 2024

turboFei requested a review from pan3793 December 25, 2024 08:29

comments

6a6a511

turboFei force-pushed the prometheus_label_2 branch from 72166a8 to 6a6a511 Compare December 25, 2024 08:30

pan3793 reviewed Dec 25, 2024

View reviewed changes

pan3793 approved these changes Dec 25, 2024

View reviewed changes

match

d24571c

pan3793 assigned turboFei Dec 25, 2024

pan3793 added this to the v1.10.2 milestone Dec 25, 2024

pan3793 closed this in aa33521 Dec 25, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Support to return prometheus metrics with instance label #6864

Support to return prometheus metrics with instance label #6864

Uh oh!

turboFei commented Dec 25, 2024 •

edited

Loading

Uh oh!

Uh oh!

pan3793 Dec 25, 2024

Uh oh!

turboFei Dec 25, 2024

Uh oh!

codecov-commenter commented Dec 25, 2024

Uh oh!

pan3793 commented Dec 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Support to return prometheus metrics with instance label #6864

Support to return prometheus metrics with instance label #6864

Uh oh!

Conversation

turboFei commented Dec 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why are the changes needed?

How was this patch tested?

Was this patch authored or co-authored using generative AI tooling?

Uh oh!

Uh oh!

pan3793 Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

turboFei Dec 25, 2024

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Dec 25, 2024

Codecov Report

Uh oh!

pan3793 commented Dec 25, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

turboFei commented Dec 25, 2024 •

edited

Loading