How does Prometheus labeling syntax works?

Question

I'm new to Prometheus and I have a very basic question.

What is the syntax to add a label to my Metrics? I tried the following:

1. Gauge.build().name(name).labelNames("label"="someLabel").help(helpMsg).register(registry);
2. Gauge.build().name(name).labelNames(label=someLabel).help(helpMsg).register(registry);
4. Gauge.build().name(name).labelNames("someLabel").help(helpMsg).register(registry);

The docs say String value, which I tried...

Someone?

DazWilkin · Accepted Answer · 2021-06-15T16:18:06.213

2

Your question lacks helpful detail to aid answering.

I assume you're using the Java SDK.

Here's the link to the documentation:

https://github.com/prometheus/client_java#labels

It appears you should use:

g = Gauge.build()
  .name(name)
  .labelNames("someLabel")
  .help(helpMsg)
  .register(registry);

And then, when you update your gauge (g), you need to specify the label(s) value(s):

g
  .labels("someLabelValue")
  .set(...);

edited Jun 15 '21 at 16:18

answered Jun 15 '21 at 16:05

DazWilkin

32,823
5
47
88

I tried that. Although I see my metric in the Prometheus metrics list, I don't see the label appears – Oded Jun 15 '21 at 16:13
Updated my answer.... when you e.g. `Set` the Gauge's value, you need to set the label value(s) too. – DazWilkin Jun 15 '21 at 16:18
I see... Thank you DazWilkin! – Oded Jun 15 '21 at 16:33

How does Prometheus labeling syntax works?

1 Answers1