io.prometheus.jmx.BuildInfoMetrics Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of collector Show documentation

See https://github.com/prometheus/jmx_exporter/blob/master/README.md

The newest version!

/*
 * Copyright (C) 2018-2023 The Prometheus jmx_exporter Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.prometheus.jmx;

import io.prometheus.metrics.core.metrics.Info;
import io.prometheus.metrics.model.registry.PrometheusRegistry;

/**
 * Collects jmx_exporter build version info.
 *
 * Example usage:
 *
 * 
{@code
 * new BuildInfoCollector()
 * }
 *
 * Metrics being exported:
 *
 *  *   jmx_exporter_build_info{version="3.2.0",name="jmx_prometheus_httpserver",} 1.0
 * 
 */
public class BuildInfoMetrics {

    /**
     * Method to register BuildInfoMetrics
     *
     * @return this BuildInfoMetrics
     */
    public BuildInfoMetrics register() {
        return register(PrometheusRegistry.defaultRegistry);
    }

    /**
     * Method to register BuildInfoMetrics
     *
     * @param prometheusRegistry prometheusRegistry
     * @return this BuildInfoMetrics
     */
    public BuildInfoMetrics register(PrometheusRegistry prometheusRegistry) {
        Info info =
                Info.builder()
                        .name("jmx_exporter_build_info")
                        .help("JMX Exporter build information")
                        .labelNames("name", "version")
                        .register(prometheusRegistry);

        Package pkg = this.getClass().getPackage();
        String name = pkg.getImplementationTitle();
        String version = pkg.getImplementationVersion();

        info.setLabelValues(name != null ? name : "unknown", version != null ? version : "unknown");

        return this;
    }
}