Class Info

Object
Metric
MetricWithFixedMetadata
Info
All Implemented Interfaces:
Collector
@StableApi public class Info extends MetricWithFixedMetadata
Info metric. Example: 
Info info = Info.builder()
        .name("java_runtime_info")
        .help("Java runtime info")
        .labelNames("env", "version", "vendor", "runtime")
        .register();

String version = System.getProperty("java.runtime.version", "unknown");
String vendor = System.getProperty("java.vm.vendor", "unknown");
String runtime = System.getProperty("java.runtime.name", "unknown");

info.addLabelValues("prod", version, vendor, runtime);
info.addLabelValues("dev", version, vendor, runtime);

  • Method Details

    • setLabelValues

      public void setLabelValues(String... labelValues)
      Set the info label values. This will replace any previous values, i.e. the info metric will only have one data point after calling setLabelValues(). This is good for a metric like target_info where you want only one single data point.

    • addLabelValues

      public void addLabelValues(String... labelValues)
      Create an info data point with the given label values.

    • remove

      public void remove(String... labelValues)
      Remove the data point with the specified label values.

    • collect

      public InfoSnapshot collect()
      Description copied from interface: Collector
      Called when the Prometheus server scrapes metrics.
      Specified by:
      collect in interface Collector
      Specified by:
      collect in class Metric

    • getMetricType

      @Deprecated public MetricType getMetricType()
      Deprecated.
      Use MetricWithFixedMetadata.getMetricFamilyDescriptor() instead.
      Description copied from interface: Collector
      Returns the metric type for registration-time validation.

      This is used to prevent different metric types (e.g., Counter and Gauge) from sharing the same name. Returning null means type validation is skipped for this collector.

      Validation is performed only at registration time. If this method returns null, no type validation is performed for this collector, and duplicate or conflicting metrics may result in invalid exposition output.

      Returns:
      the metric type, or null to skip validation

    • builder

      public static Info.Builder builder()

    • builder

      public static Info.Builder builder(PrometheusProperties config)