io.bdeploy.jersey.resources.JerseyMetricsResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of api Show documentation
Public API including dependencies, ready to be used for integrations and plugins.
There is a newer version: 7.3.6
package io.bdeploy.jersey.resources;

import java.util.Map;
import java.util.SortedMap;
import java.util.TreeMap;

import io.bdeploy.common.metrics.Metrics.MetricGroup;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

/**
 * A resource which allows remote access to server metrics.
 */
@Path("/metrics")
@Produces(MediaType.APPLICATION_JSON)
public interface JerseyMetricsResource {

    /**
     * Bundles all metrics in a serialization/JSON friendly way.
     */
    public class MetricBundle {

        public SortedMap counters = new TreeMap<>();
        public SortedMap histograms = new TreeMap<>();
        public SortedMap timers = new TreeMap<>();
        public SortedMap> gauges = new TreeMap<>();
        public SortedMap meters = new TreeMap<>();
    }

    /**
     * A metric counting occurrences.
     */
    public class CounterMetric {

        public CounterFields counter = new CounterFields();
    }

    /**
     * A metric counting values and keeping track of their distribution
     */
    public class HistogramMetric {

        public CounterFields counter = new CounterFields();
        public HistogramFields histogram = new HistogramFields();
    }

    /**
     * Count and measure rates of metric occurrence as well as keeping track of
     * occurrence duration distribution.
     * 
     * Note: time is stored in nanoseconds in the histogram.
     */
    public class TimerMetric {

        public CounterFields counter = new CounterFields();
        public MeterFields meter = new MeterFields();
        public HistogramFields histogram = new HistogramFields();
    }

    /**
     * Keeps track of a snapshot of a value
     */
    public class GaugeMetric {

        public T value;
    }

    /**
     * Count and measure rates of metric occurrence.
     */
    public class MeterMetric {

        public CounterFields counter = new CounterFields();
        public MeterFields meter = new MeterFields();
    }

    /**
     * Fields used in metrics which count occurrences
     */
    public class CounterFields {

        public long value;
    }

    /**
     * Fields used in metrics which meter rates
     */
    public class MeterFields {

        public double meanRate;
        public double oneMinRate;
        public double fiveMinRate;
        public double fifteenMinRate;
    }

    /**
     * Fields used in metrics which keep track of value distribution
     */
    public class HistogramFields {

        public long min;
        public long max;
        public double mean;
        public double stdDev;
        public double median;
        public double p75th;
        public double p95th;
        public double p98th;
        public double p99th;
        public double p999th;

        public long size;
        public long[] values;
    }

    /**
     * @return all currently available metrics
     */
    @GET
    public Map getAllMetrics();

}