Add custom tags to JVM metrics (#1769)

Fixes #1694

---------

Signed-off-by: Sibasis Padhi <sibasis.padhi@gmail.com>

Author: sibasispadhi

prometheus-metrics-instrumentation-jvm/src/main/java/io/prometheus/metrics/instrumentation/jvm/JvmBufferPoolMetrics.java

@@ -3,6 +3,7 @@
 import io.prometheus.metrics.config.PrometheusProperties;
 import io.prometheus.metrics.core.metrics.GaugeWithCallback;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import io.prometheus.metrics.model.snapshots.Labels;
 import io.prometheus.metrics.model.snapshots.Unit;
 import java.lang.management.BufferPoolMXBean;
 import java.lang.management.ManagementFactory;
@@ -48,11 +49,13 @@ public class JvmBufferPoolMetrics {
 
   private final PrometheusProperties config;
   private final List<BufferPoolMXBean> bufferPoolBeans;
+  private final Labels constLabels;
 
   private JvmBufferPoolMetrics(
-      List<BufferPoolMXBean> bufferPoolBeans, PrometheusProperties config) {
+      List<BufferPoolMXBean> bufferPoolBeans, PrometheusProperties config, Labels constLabels) {
     this.config = config;
     this.bufferPoolBeans = bufferPoolBeans;
+    this.constLabels = constLabels;
   }
 
   private void register(PrometheusRegistry registry) {
@@ -68,6 +71,7 @@ private void register(PrometheusRegistry registry) {
                 callback.call(pool.getMemoryUsed(), pool.getName());
               }
             })
+        .constLabels(constLabels)
         .register(registry);
 
     GaugeWithCallback.builder(config)
@@ -81,6 +85,7 @@ private void register(PrometheusRegistry registry) {
                 callback.call(pool.getTotalCapacity(), pool.getName());
               }
             })
+        .constLabels(constLabels)
         .register(registry);
 
     GaugeWithCallback.builder(config)
@@ -93,6 +98,7 @@ private void register(PrometheusRegistry registry) {
                 callback.call(pool.getCount(), pool.getName());
               }
             })
+        .constLabels(constLabels)
         .register(registry);
   }
 
@@ -108,11 +114,17 @@ public static class Builder {
 
     private final PrometheusProperties config;
     @Nullable private List<BufferPoolMXBean> bufferPoolBeans;
+    private Labels constLabels = Labels.EMPTY;
 
     private Builder(PrometheusProperties config) {
       this.config = config;
     }
 
+    public Builder constLabels(Labels constLabels) {
+      this.constLabels = constLabels;
+      return this;
+    }
+
     /** Package private. For testing only. */
     Builder bufferPoolBeans(List<BufferPoolMXBean> bufferPoolBeans) {
       this.bufferPoolBeans = bufferPoolBeans;
@@ -128,7 +140,7 @@ public void register(PrometheusRegistry registry) {
       if (bufferPoolBeans == null) {
         bufferPoolBeans = ManagementFactory.getPlatformMXBeans(BufferPoolMXBean.class);
       }
-      new JvmBufferPoolMetrics(bufferPoolBeans, config).register(registry);
+      new JvmBufferPoolMetrics(bufferPoolBeans, config, constLabels).register(registry);
     }
   }
 }

prometheus-metrics-instrumentation-jvm/src/main/java/io/prometheus/metrics/instrumentation/jvm/JvmClassLoadingMetrics.java

@@ -4,6 +4,7 @@
 import io.prometheus.metrics.core.metrics.CounterWithCallback;
 import io.prometheus.metrics.core.metrics.GaugeWithCallback;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import io.prometheus.metrics.model.snapshots.Labels;
 import java.lang.management.ClassLoadingMXBean;
 import java.lang.management.ManagementFactory;
 import javax.annotation.Nullable;
@@ -44,10 +45,13 @@ public class JvmClassLoadingMetrics {
 
   private final PrometheusProperties config;
   private final ClassLoadingMXBean classLoadingBean;
+  private final Labels constLabels;
 
-  private JvmClassLoadingMetrics(ClassLoadingMXBean classLoadingBean, PrometheusProperties config) {
+  private JvmClassLoadingMetrics(
+      ClassLoadingMXBean classLoadingBean, PrometheusProperties config, Labels constLabels) {
     this.classLoadingBean = classLoadingBean;
     this.config = config;
+    this.constLabels = constLabels;
   }
 
   private void register(PrometheusRegistry registry) {
@@ -56,13 +60,15 @@ private void register(PrometheusRegistry registry) {
         .name(JVM_CLASSES_CURRENTLY_LOADED)
         .help("The number of classes that are currently loaded in the JVM")
         .callback(callback -> callback.call(classLoadingBean.getLoadedClassCount()))
+        .constLabels(constLabels)
         .register(registry);
 
     CounterWithCallback.builder(config)
         .name(JVM_CLASSES_LOADED_TOTAL)
         .help(
             "The total number of classes that have been loaded since the JVM has started execution")
         .callback(callback -> callback.call(classLoadingBean.getTotalLoadedClassCount()))
+        .constLabels(constLabels)
         .register(registry);
 
     CounterWithCallback.builder(config)
@@ -71,6 +77,7 @@ private void register(PrometheusRegistry registry) {
             "The total number of classes that have been unloaded since the JVM has "
                 + "started execution")
         .callback(callback -> callback.call(classLoadingBean.getUnloadedClassCount()))
+        .constLabels(constLabels)
         .register(registry);
   }
 
@@ -86,11 +93,17 @@ public static class Builder {
 
     private final PrometheusProperties config;
     @Nullable private ClassLoadingMXBean classLoadingBean;
+    private Labels constLabels = Labels.EMPTY;
 
     private Builder(PrometheusProperties config) {
       this.config = config;
     }
 
+    public Builder constLabels(Labels constLabels) {
+      this.constLabels = constLabels;
+      return this;
+    }
+
     /** Package private. For testing only. */
     Builder classLoadingBean(ClassLoadingMXBean classLoadingBean) {
       this.classLoadingBean = classLoadingBean;
@@ -106,7 +119,7 @@ public void register(PrometheusRegistry registry) {
           this.classLoadingBean != null
               ? this.classLoadingBean
               : ManagementFactory.getClassLoadingMXBean();
-      new JvmClassLoadingMetrics(classLoadingBean, config).register(registry);
+      new JvmClassLoadingMetrics(classLoadingBean, config, constLabels).register(registry);
     }
   }
 }

prometheus-metrics-instrumentation-jvm/src/main/java/io/prometheus/metrics/instrumentation/jvm/JvmCompilationMetrics.java

@@ -5,6 +5,7 @@
 import io.prometheus.metrics.config.PrometheusProperties;
 import io.prometheus.metrics.core.metrics.CounterWithCallback;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import io.prometheus.metrics.model.snapshots.Labels;
 import io.prometheus.metrics.model.snapshots.Unit;
 import java.lang.management.CompilationMXBean;
 import java.lang.management.ManagementFactory;
@@ -39,10 +40,13 @@ public class JvmCompilationMetrics {
 
   private final PrometheusProperties config;
   private final CompilationMXBean compilationBean;
+  private final Labels constLabels;
 
-  private JvmCompilationMetrics(CompilationMXBean compilationBean, PrometheusProperties config) {
+  private JvmCompilationMetrics(
+      CompilationMXBean compilationBean, PrometheusProperties config, Labels constLabels) {
     this.compilationBean = compilationBean;
     this.config = config;
+    this.constLabels = constLabels;
   }
 
   private void register(PrometheusRegistry registry) {
@@ -57,6 +61,7 @@ private void register(PrometheusRegistry registry) {
         .unit(Unit.SECONDS)
         .callback(
             callback -> callback.call(millisToSeconds(compilationBean.getTotalCompilationTime())))
+        .constLabels(constLabels)
         .register(registry);
   }
 
@@ -72,11 +77,17 @@ public static class Builder {
 
     private final PrometheusProperties config;
     @Nullable private CompilationMXBean compilationBean;
+    private Labels constLabels = Labels.EMPTY;
 
     private Builder(PrometheusProperties config) {
       this.config = config;
     }
 
+    public Builder constLabels(Labels constLabels) {
+      this.constLabels = constLabels;
+      return this;
+    }
+
     /** Package private. For testing only. */
     Builder compilationBean(CompilationMXBean compilationBean) {
       this.compilationBean = compilationBean;
@@ -92,7 +103,7 @@ public void register(PrometheusRegistry registry) {
           this.compilationBean != null
               ? this.compilationBean
               : ManagementFactory.getCompilationMXBean();
-      new JvmCompilationMetrics(compilationBean, config).register(registry);
+      new JvmCompilationMetrics(compilationBean, config, constLabels).register(registry);
     }
   }
 }

prometheus-metrics-instrumentation-jvm/src/main/java/io/prometheus/metrics/instrumentation/jvm/JvmGarbageCollectorMetrics.java

@@ -3,6 +3,7 @@
 import io.prometheus.metrics.config.PrometheusProperties;
 import io.prometheus.metrics.core.metrics.SummaryWithCallback;
 import io.prometheus.metrics.model.registry.PrometheusRegistry;
+import io.prometheus.metrics.model.snapshots.Labels;
 import io.prometheus.metrics.model.snapshots.Quantiles;
 import io.prometheus.metrics.model.snapshots.Unit;
 import java.lang.management.GarbageCollectorMXBean;
@@ -42,11 +43,15 @@ public class JvmGarbageCollectorMetrics {
 
   private final PrometheusProperties config;
   private final List<GarbageCollectorMXBean> garbageCollectorBeans;
+  private final Labels constLabels;
 
   private JvmGarbageCollectorMetrics(
-      List<GarbageCollectorMXBean> garbageCollectorBeans, PrometheusProperties config) {
+      List<GarbageCollectorMXBean> garbageCollectorBeans,
+      PrometheusProperties config,
+      Labels constLabels) {
     this.config = config;
     this.garbageCollectorBeans = garbageCollectorBeans;
+    this.constLabels = constLabels;
   }
 
   private void register(PrometheusRegistry registry) {
@@ -66,6 +71,7 @@ private void register(PrometheusRegistry registry) {
                     gc.getName());
               }
             })
+        .constLabels(constLabels)
         .register(registry);
   }
 
@@ -81,11 +87,17 @@ public static class Builder {
 
     private final PrometheusProperties config;
     @Nullable private List<GarbageCollectorMXBean> garbageCollectorBeans;
+    private Labels constLabels = Labels.EMPTY;
 
     private Builder(PrometheusProperties config) {
       this.config = config;
     }
 
+    public Builder constLabels(Labels constLabels) {
+      this.constLabels = constLabels;
+      return this;
+    }
+
     /** Package private. For testing only. */
     Builder garbageCollectorBeans(List<GarbageCollectorMXBean> garbageCollectorBeans) {
       this.garbageCollectorBeans = garbageCollectorBeans;
@@ -101,7 +113,7 @@ public void register(PrometheusRegistry registry) {
       if (garbageCollectorBeans == null) {
         garbageCollectorBeans = ManagementFactory.getGarbageCollectorMXBeans();
       }
-      new JvmGarbageCollectorMetrics(garbageCollectorBeans, config).register(registry);
+      new JvmGarbageCollectorMetrics(garbageCollectorBeans, config, constLabels).register(registry);
     }
   }
 }