• Home
• io.micrometer
• micrometer-registry-prometheus-simpleclient
• 1.14.2
• source code
• PrometheusMeterRegistry.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.micrometer.prometheus.PrometheusMeterRegistry Maven / Gradle / Ivy

/*
 * Copyright 2017 VMware, Inc.
 *
 * 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
 *
 * https://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.micrometer.prometheus;

import io.micrometer.common.lang.Nullable;
import io.micrometer.core.instrument.*;
import io.micrometer.core.instrument.cumulative.CumulativeFunctionCounter;
import io.micrometer.core.instrument.cumulative.CumulativeFunctionTimer;
import io.micrometer.core.instrument.distribution.*;
import io.micrometer.core.instrument.distribution.pause.PauseDetector;
import io.micrometer.core.instrument.internal.CumulativeHistogramLongTaskTimer;
import io.micrometer.core.instrument.internal.DefaultGauge;
import io.micrometer.core.instrument.internal.DefaultMeter;
import io.prometheus.client.Collector;
import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.exemplars.Exemplar;
import io.prometheus.client.exemplars.ExemplarSampler;
import io.prometheus.client.exporter.common.TextFormat;

import java.io.IOException;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Enumeration;
import java.util.List;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.concurrent.TimeUnit;
import java.util.function.*;
import java.util.stream.Stream;

import static java.util.stream.Collectors.joining;
import static java.util.stream.Collectors.toList;
import static java.util.stream.StreamSupport.stream;

/**
 * {@link MeterRegistry} for Prometheus.
 *
 * @deprecated since 1.13.0, use the class with the same name from
 * io.micrometer:micrometer-registry-prometheus instead:
 * {@code io.micrometer.prometheusmetrics.PrometheusMeterRegistry}.
 * @author Jon Schneider
 * @author Johnny Lim
 * @author Jonatan Ivanov
 */
@Deprecated
public class PrometheusMeterRegistry extends MeterRegistry {

    private final PrometheusConfig prometheusConfig;

    private final CollectorRegistry registry;

    private final ConcurrentMap collectorMap = new ConcurrentHashMap<>();

    @Nullable
    private final ExemplarSampler exemplarSampler;

    public PrometheusMeterRegistry(PrometheusConfig config) {
        this(config, new CollectorRegistry(), Clock.SYSTEM);
    }

    public PrometheusMeterRegistry(PrometheusConfig config, CollectorRegistry registry, Clock clock) {
        this(config, registry, clock, null);
    }

    /**
     * Create a {@code PrometheusMeterRegistry} instance.
     * @param config configuration
     * @param registry collector registry
     * @param clock clock
     * @param exemplarSampler exemplar sampler
     * @since 1.9.0
     */
    public PrometheusMeterRegistry(PrometheusConfig config, CollectorRegistry registry, Clock clock,
            @Nullable ExemplarSampler exemplarSampler) {
        super(clock);

        config.requireValid();

        this.prometheusConfig = config;
        this.registry = registry;
        this.exemplarSampler = exemplarSampler;

        config().namingConvention(new PrometheusNamingConvention());
        config().onMeterRemoved(this::onMeterRemoved);
    }

    private static List tagValues(Meter.Id id) {
        return stream(id.getTagsAsIterable().spliterator(), false).map(Tag::getValue).collect(toList());
    }

    /**
     * @return Content in Prometheus text format for the response body of an endpoint
     * designated for Prometheus to scrape.
     */
    public String scrape() {
        return scrape(TextFormat.CONTENT_TYPE_004);
    }

    /**
     * Get the metrics scrape body in a specific content type.
     * @param contentType the scrape Content-Type
     * @return the scrape body
     * @see TextFormat
     * @since 1.7.0
     */
    public String scrape(String contentType) {
        Writer writer = new StringWriter();
        try {
            scrape(writer, contentType);
        }
        catch (IOException e) {
            // This actually never happens since StringWriter::write() doesn't throw any
            // IOException
            throw new RuntimeException(e);
        }
        return writer.toString();
    }

    /**
     * Scrape to the specified writer in Prometheus text format.
     * @param writer Target that serves the content to be scraped by Prometheus.
     * @throws IOException if writing fails
     * @since 1.2.0
     */
    public void scrape(Writer writer) throws IOException {
        scrape(writer, TextFormat.CONTENT_TYPE_004);
    }

    /**
     * Write the metrics scrape body in a specific content type to the given writer.
     * @param writer where to write the scrape body
     * @param contentType the Content-Type of the scrape
     * @throws IOException if writing fails
     * @see TextFormat
     * @since 1.7.0
     */
    public void scrape(Writer writer, String contentType) throws IOException {
        scrape(writer, contentType, registry.metricFamilySamples());
    }

    private void scrape(Writer writer, String contentType, Enumeration samples)
            throws IOException {
        TextFormat.writeFormat(contentType, writer, samples);
    }

    /**
     * Return text for scraping.
     * @param contentType the Content-Type of the scrape.
     * @param includedNames Sample names to be included. All samples will be included if
     * {@code null}.
     * @return Content that should be included in the response body for an endpoint
     * designated for Prometheus to scrape from.
     * @since 1.7.0
     */
    public String scrape(String contentType, @Nullable Set includedNames) {
        Writer writer = new StringWriter();
        try {
            scrape(writer, contentType, includedNames);
        }
        catch (IOException e) {
            // This actually never happens since StringWriter::write() doesn't throw any
            // IOException
            throw new RuntimeException(e);
        }
        return writer.toString();
    }

    /**
     * Scrape to the specified writer.
     * @param writer Target that serves the content to be scraped by Prometheus.
     * @param contentType the Content-Type of the scrape.
     * @param includedNames Sample names to be included. All samples will be included if
     * {@code null}.
     * @throws IOException if writing fails
     * @since 1.7.0
     */
    public void scrape(Writer writer, String contentType, @Nullable Set includedNames) throws IOException {
        Enumeration samples = includedNames != null
                ? registry.filteredMetricFamilySamples(includedNames) : registry.metricFamilySamples();
        scrape(writer, contentType, samples);
    }

    @Override
    public Counter newCounter(Meter.Id id) {
        PrometheusCounter counter = new PrometheusCounter(id, exemplarSampler);
        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues,
                    (conventionName,
                            tagKeys) -> Stream.of(new MicrometerCollector.Family(Collector.Type.COUNTER, conventionName,
                                    new Collector.MetricFamilySamples.Sample(conventionName, tagKeys, tagValues,
                                            counter.count(), counter.exemplar()))));
        });
        return counter;
    }

    @Override
    public DistributionSummary newDistributionSummary(Meter.Id id,
            DistributionStatisticConfig distributionStatisticConfig, double scale) {
        PrometheusDistributionSummary summary = new PrometheusDistributionSummary(id, clock,
                distributionStatisticConfig, scale, prometheusConfig.histogramFlavor(), exemplarSampler);
        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues, (conventionName, tagKeys) -> {
                Stream.Builder samples = Stream.builder();

                final ValueAtPercentile[] percentileValues = summary.takeSnapshot().percentileValues();
                final CountAtBucket[] histogramCounts = summary.histogramCounts();
                double count = summary.count();

                if (percentileValues.length > 0) {
                    List quantileKeys = new ArrayList<>(tagKeys);
                    quantileKeys.add("quantile");

                    // satisfies https://prometheus.io/docs/concepts/metric_types/#summary
                    for (ValueAtPercentile v : percentileValues) {
                        List quantileValues = new ArrayList<>(tagValues);
                        quantileValues.add(Collector.doubleToGoString(v.percentile()));
                        samples.add(new Collector.MetricFamilySamples.Sample(conventionName, quantileKeys,
                                quantileValues, v.value()));
                    }
                }

                Exemplar lastExemplar = summary.lastExemplar();
                Collector.Type type = Collector.Type.SUMMARY;
                if (histogramCounts.length > 0) {
                    // Prometheus doesn't balk at a metric being BOTH a histogram and a
                    // summary
                    type = Collector.Type.HISTOGRAM;

                    List histogramKeys = new ArrayList<>(tagKeys);
                    String sampleName = conventionName + "_bucket";
                    switch (summary.histogramFlavor()) {
                        case Prometheus:
                            histogramKeys.add("le");

                            Exemplar[] exemplars = summary.histogramExemplars();

                            // satisfies
                            // https://prometheus.io/docs/concepts/metric_types/#histogram
                            for (int i = 0; i < histogramCounts.length; i++) {
                                CountAtBucket c = histogramCounts[i];
                                final List histogramValues = new ArrayList<>(tagValues);

                                histogramValues.add(Collector.doubleToGoString(c.bucket()));

                                if (exemplars == null) {
                                    samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                            histogramValues, c.count()));
                                }
                                else {
                                    samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                            histogramValues, c.count(), exemplars[i]));
                                }
                            }

                            if (Double.isFinite(histogramCounts[histogramCounts.length - 1].bucket())) {
                                // the +Inf bucket should always equal `count`
                                final List histogramValues = new ArrayList<>(tagValues);
                                histogramValues.add("+Inf");
                                if (exemplars == null) {
                                    samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                            histogramValues, count));
                                }
                                else {
                                    samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                            histogramValues, count, exemplars[exemplars.length - 1]));
                                }
                            }
                            break;
                        case VictoriaMetrics:
                            histogramKeys.add("vmrange");

                            for (CountAtBucket c : histogramCounts) {
                                final List histogramValuesVM = new ArrayList<>(tagValues);
                                histogramValuesVM
                                    .add(FixedBoundaryVictoriaMetricsHistogram.getRangeTagValue(c.bucket()));
                                samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                        histogramValuesVM, c.count()));
                            }
                            break;
                        default:
                            break;
                    }

                }

                if (lastExemplar == null) {
                    samples.add(new Collector.MetricFamilySamples.Sample(conventionName + "_count", tagKeys, tagValues,
                            count));
                }
                else {
                    samples.add(new Collector.MetricFamilySamples.Sample(conventionName + "_count", tagKeys, tagValues,
                            count, copyExemplarWithNewValue(1.0, lastExemplar)));
                }

                samples.add(new Collector.MetricFamilySamples.Sample(conventionName + "_sum", tagKeys, tagValues,
                        summary.totalAmount()));

                return Stream.of(new MicrometerCollector.Family(type, conventionName, samples.build()),
                        new MicrometerCollector.Family(Collector.Type.GAUGE, conventionName + "_max",
                                new Collector.MetricFamilySamples.Sample(conventionName + "_max", tagKeys, tagValues,
                                        summary.max())));
            });
        });
        return summary;
    }

    @Override
    protected io.micrometer.core.instrument.Timer newTimer(Meter.Id id,
            DistributionStatisticConfig distributionStatisticConfig, PauseDetector pauseDetector) {
        PrometheusTimer timer = new PrometheusTimer(id, clock, distributionStatisticConfig, pauseDetector,
                prometheusConfig.histogramFlavor(), exemplarSampler);
        applyToCollector(id, (collector) -> addDistributionStatisticSamples(distributionStatisticConfig, collector,
                timer, timer::lastExemplar, timer::histogramExemplars, tagValues(id), false));
        return timer;
    }

    @Override
    protected  io.micrometer.core.instrument.Gauge newGauge(Meter.Id id, @Nullable T obj,
            ToDoubleFunction valueFunction) {
        Gauge gauge = new DefaultGauge<>(id, obj, valueFunction);
        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues, (conventionName, tagKeys) -> Stream
                .of(new MicrometerCollector.Family(Collector.Type.GAUGE, conventionName,
                        new Collector.MetricFamilySamples.Sample(conventionName, tagKeys, tagValues, gauge.value()))));
        });
        return gauge;
    }

    @Override
    protected LongTaskTimer newLongTaskTimer(Meter.Id id, DistributionStatisticConfig distributionStatisticConfig) {
        LongTaskTimer ltt = new CumulativeHistogramLongTaskTimer(id, clock, getBaseTimeUnit(),
                distributionStatisticConfig);
        applyToCollector(id, (collector) -> addDistributionStatisticSamples(distributionStatisticConfig, collector, ltt,
                () -> null, () -> null, tagValues(id), true));
        return ltt;
    }

    @Override
    protected  FunctionTimer newFunctionTimer(Meter.Id id, T obj, ToLongFunction countFunction,
            ToDoubleFunction totalTimeFunction, TimeUnit totalTimeFunctionUnit) {
        FunctionTimer ft = new CumulativeFunctionTimer<>(id, obj, countFunction, totalTimeFunction,
                totalTimeFunctionUnit, getBaseTimeUnit());
        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues,
                    (conventionName,
                            tagKeys) -> Stream.of(new MicrometerCollector.Family(Collector.Type.SUMMARY, conventionName,
                                    new Collector.MetricFamilySamples.Sample(conventionName + "_count", tagKeys,
                                            tagValues, ft.count()),
                                    new Collector.MetricFamilySamples.Sample(conventionName + "_sum", tagKeys,
                                            tagValues, ft.totalTime(TimeUnit.SECONDS)))));
        });
        return ft;
    }

    @Override
    protected  FunctionCounter newFunctionCounter(Meter.Id id, T obj, ToDoubleFunction countFunction) {
        FunctionCounter fc = new CumulativeFunctionCounter<>(id, obj, countFunction);
        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues,
                    (conventionName, tagKeys) -> Stream.of(new MicrometerCollector.Family(Collector.Type.COUNTER,
                            conventionName,
                            new Collector.MetricFamilySamples.Sample(conventionName, tagKeys, tagValues, fc.count()))));
        });
        return fc;
    }

    @Override
    protected Meter newMeter(Meter.Id id, Meter.Type type, Iterable measurements) {
        Collector.Type promType = Collector.Type.UNKNOWN;
        switch (type) {
            case COUNTER:
                promType = Collector.Type.COUNTER;
                break;
            case GAUGE:
                promType = Collector.Type.GAUGE;
                break;
            case DISTRIBUTION_SUMMARY:
            case TIMER:
                promType = Collector.Type.SUMMARY;
                break;
        }

        final Collector.Type finalPromType = promType;

        applyToCollector(id, (collector) -> {
            List tagValues = tagValues(id);
            collector.add(tagValues, (conventionName, tagKeys) -> {
                List statKeys = new ArrayList<>(tagKeys);
                statKeys.add("statistic");

                return Stream.of(new MicrometerCollector.Family(finalPromType, conventionName,
                        stream(measurements.spliterator(), false).map(m -> {
                            List statValues = new ArrayList<>(tagValues);
                            statValues.add(m.getStatistic().toString());

                            String name = conventionName;
                            switch (m.getStatistic()) {
                                case TOTAL:
                                case TOTAL_TIME:
                                    name += "_sum";
                                    break;
                                case MAX:
                                    name += "_max";
                                    break;
                                case ACTIVE_TASKS:
                                    name += "_active_count";
                                    break;
                                case DURATION:
                                    name += "_duration_sum";
                                    break;
                            }

                            return new Collector.MetricFamilySamples.Sample(name, statKeys, statValues, m.getValue());
                        })));
            });
        });

        return new DefaultMeter(id, type, measurements);
    }

    @Override
    protected TimeUnit getBaseTimeUnit() {
        return TimeUnit.SECONDS;
    }

    /**
     * @return The underlying Prometheus {@link CollectorRegistry}.
     */
    public CollectorRegistry getPrometheusRegistry() {
        return registry;
    }

    private void addDistributionStatisticSamples(DistributionStatisticConfig distributionStatisticConfig,
            MicrometerCollector collector, HistogramSupport histogramSupport, Supplier lastExemplarSupplier,
            Supplier histogramExemplarsSupplier, List tagValues, boolean forLongTaskTimer) {
        collector.add(tagValues, (conventionName, tagKeys) -> {
            Stream.Builder samples = Stream.builder();

            HistogramSnapshot histogramSnapshot = histogramSupport.takeSnapshot();
            ValueAtPercentile[] percentileValues = histogramSnapshot.percentileValues();
            CountAtBucket[] histogramCounts = histogramSnapshot.histogramCounts();
            double count = histogramSnapshot.count();

            if (percentileValues.length > 0) {
                List quantileKeys = new ArrayList<>(tagKeys);
                quantileKeys.add("quantile");

                // satisfies https://prometheus.io/docs/concepts/metric_types/#summary
                for (ValueAtPercentile v : percentileValues) {
                    List quantileValues = new ArrayList<>(tagValues);
                    quantileValues.add(Collector.doubleToGoString(v.percentile()));
                    samples.add(new Collector.MetricFamilySamples.Sample(conventionName, quantileKeys, quantileValues,
                            v.value(TimeUnit.SECONDS)));
                }
            }

            Exemplar lastExemplar = lastExemplarSupplier.get();
            Collector.Type type = distributionStatisticConfig.isPublishingHistogram() ? Collector.Type.HISTOGRAM
                    : Collector.Type.SUMMARY;
            if (histogramCounts.length > 0) {
                // Prometheus doesn't balk at a metric being BOTH a histogram and a
                // summary
                type = Collector.Type.HISTOGRAM;

                List histogramKeys = new ArrayList<>(tagKeys);

                String sampleName = conventionName + "_bucket";
                switch (prometheusConfig.histogramFlavor()) {
                    case Prometheus:
                        histogramKeys.add("le");

                        Exemplar[] exemplars = histogramExemplarsSupplier.get();

                        // satisfies
                        // https://prometheus.io/docs/concepts/metric_types/#histogram
                        for (int i = 0; i < histogramCounts.length; i++) {
                            CountAtBucket c = histogramCounts[i];
                            final List histogramValues = new ArrayList<>(tagValues);
                            histogramValues.add(Collector.doubleToGoString(c.bucket(TimeUnit.SECONDS)));
                            if (exemplars == null) {
                                samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                        histogramValues, c.count()));
                            }
                            else {
                                samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                        histogramValues, c.count(), exemplars[i]));
                            }
                        }

                        // the +Inf bucket should always equal `count`
                        final List histogramValues = new ArrayList<>(tagValues);
                        histogramValues.add("+Inf");
                        if (exemplars == null) {
                            samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                    histogramValues, count));
                        }
                        else {
                            samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                    histogramValues, count, exemplars[exemplars.length - 1]));
                        }
                        break;
                    case VictoriaMetrics:
                        histogramKeys.add("vmrange");

                        for (CountAtBucket c : histogramCounts) {
                            final List histogramValuesVM = new ArrayList<>(tagValues);
                            histogramValuesVM.add(FixedBoundaryVictoriaMetricsHistogram.getRangeTagValue(c.bucket()));
                            samples.add(new Collector.MetricFamilySamples.Sample(sampleName, histogramKeys,
                                    histogramValuesVM, c.count()));
                        }
                        break;
                    default:
                        break;
                }

            }

            if (lastExemplar == null) {
                samples.add(new Collector.MetricFamilySamples.Sample(
                        conventionName + (forLongTaskTimer ? "_active_count" : "_count"), tagKeys, tagValues, count));
            }
            else {
                samples.add(new Collector.MetricFamilySamples.Sample(
                        conventionName + (forLongTaskTimer ? "_active_count" : "_count"), tagKeys, tagValues, count,
                        copyExemplarWithNewValue(1.0, lastExemplar)));
            }

            samples.add(new Collector.MetricFamilySamples.Sample(
                    conventionName + (forLongTaskTimer ? "_duration_sum" : "_sum"), tagKeys, tagValues,
                    histogramSnapshot.total(TimeUnit.SECONDS)));

            return Stream.of(new MicrometerCollector.Family(type, conventionName, samples.build()),
                    new MicrometerCollector.Family(Collector.Type.GAUGE, conventionName + "_max",
                            Stream.of(new Collector.MetricFamilySamples.Sample(conventionName + "_max", tagKeys,
                                    tagValues, histogramSnapshot.max(getBaseTimeUnit())))));
        });
    }

    private Exemplar copyExemplarWithNewValue(double newValue, Exemplar exemplar) {
        String[] labels = new String[exemplar.getNumberOfLabels() * 2];
        for (int i = 0; i < exemplar.getNumberOfLabels(); i++) {
            labels[2 * i] = exemplar.getLabelName(i);
            labels[2 * i + 1] = exemplar.getLabelValue(i);
        }
        return new Exemplar(newValue, exemplar.getTimestampMs(), labels);
    }

    private void onMeterRemoved(Meter meter) {
        MicrometerCollector collector = collectorMap.get(getConventionName(meter.getId()));
        if (collector != null) {
            collector.remove(tagValues(meter.getId()));
            if (collector.isEmpty()) {
                collectorMap.remove(getConventionName(meter.getId()));
                getPrometheusRegistry().unregister(collector);
            }
        }
    }

    private void applyToCollector(Meter.Id id, Consumer consumer) {
        collectorMap.compute(getConventionName(id), (name, existingCollector) -> {
            if (existingCollector == null) {
                MicrometerCollector micrometerCollector = new MicrometerCollector(name, id, config().namingConvention(),
                        prometheusConfig);
                consumer.accept(micrometerCollector);
                return micrometerCollector.register(registry);
            }

            List tagKeys = getConventionTags(id).stream().map(Tag::getKey).collect(toList());
            if (existingCollector.getTagKeys().equals(tagKeys)) {
                consumer.accept(existingCollector);
                return existingCollector;
            }

            meterRegistrationFailed(id,
                    "Prometheus requires that all meters with the same name have the same"
                            + " set of tag keys. There is already an existing meter named '" + id.getName()
                            + "' containing tag keys ["
                            + String.join(", ", collectorMap.get(getConventionName(id)).getTagKeys())
                            + "]. The meter you are attempting to register" + " has keys ["
                            + getConventionTags(id).stream().map(Tag::getKey).collect(joining(", ")) + "].");
            return existingCollector;
        });
    }

    @Override
    protected DistributionStatisticConfig defaultHistogramConfig() {
        return DistributionStatisticConfig.builder()
            .expiry(prometheusConfig.step())
            .build()
            .merge(DistributionStatisticConfig.DEFAULT);
    }

    /**
     * For use with
     * {@link io.micrometer.core.instrument.MeterRegistry.Config#onMeterRegistrationFailed(BiConsumer)
     * MeterRegistry.Config#onMeterRegistrationFailed(BiConsumer)} when you want meters
     * with the same name but different tags to cause an unchecked exception.
     * @return This registry
     * @since 1.6.0
     */
    public PrometheusMeterRegistry throwExceptionOnRegistrationFailure() {
        config().onMeterRegistrationFailed((id, reason) -> {
            throw new IllegalArgumentException(reason);
        });

        return this;
    }

}