ai.eloquent.monitoring

Class Prometheus

java.lang.Object

ai.eloquent.monitoring.Prometheus

public class Prometheus
extends java.lang.Object

A facade for handling calls to Prometheus When Prometheus is not found in the classpath, or a different version is found, we revert to a mocked version of Prometheus We enforce that 2 metrics with the same name refer to the same metric. Author: zameschua

Method Summary

Modifier and Type	Method and Description
static java.lang.Object	counterBuild(java.lang.String name, java.lang.String help) Builds a new Prometheus Counter metric, if possible.
static void	counterInc(java.lang.Object counter) Increments the value in the Prometheus Counter by 1, if possible.
static java.lang.Object	gaugeBuild(java.lang.String name, java.lang.String help) Builds a new Prometheus Gauge metric, if possible.
static void	gaugeDec(java.lang.Object gauge) Decrements the value in the Prometheus Gauge by 1, if possible.
static double	gaugeGet(java.lang.Object gauge) Gets the current value stored in the Prometheus Gauge, if possible.
static void	gaugeInc(java.lang.Object gauge) Increments the value in the Prometheus Gauge by 1, if possible.
static void	gaugeSet(java.lang.Object gauge, double val) Sets the Prometheus Gauge to a given value, if possible.
static boolean	havePrometheus() Getter method for this.havePrometheus
static double	observeDuration(java.lang.Object timer) Observe duration on a Prometheus timer.
static java.lang.Object	startTimer(java.lang.Object summary, java.lang.String... labels) Start a timer on a summary metric to track a duration Call observeDuration(Object) at the end of what you want to measure the duration of.
static java.lang.Object	summaryBuild(java.lang.String name, java.lang.String help, java.lang.String... labels) Builds and returns a new Prometheus Summary object, if possible.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

summaryBuild

public static java.lang.Object summaryBuild(java.lang.String name,
                                            java.lang.String help,
                                            java.lang.String... labels)

Builds and returns a new Prometheus Summary object, if possible.

Parameters:

name - The name of the metric

help - The help string of the metric

labels - The label to attach to the metric

Returns:

The Summary object

startTimer

public static java.lang.Object startTimer(@Nullable
                                          java.lang.Object summary,
                                          java.lang.String... labels)

Start a timer on a summary metric to track a duration Call observeDuration(Object) at the end of what you want to measure the duration of.

Parameters:

summary - The Summary metric to start the timer on

labels - The labels to attach

Returns:

the Prometheus Timer object

observeDuration

public static double observeDuration(@Nullable
                                     java.lang.Object timer)

Observe duration on a Prometheus timer.

Parameters:

timer - The prometheus timer.

gaugeBuild

public static java.lang.Object gaugeBuild(java.lang.String name,
                                          java.lang.String help)

Builds a new Prometheus Gauge metric, if possible.

Parameters:

name - The name of the metric

help - The help string of the metric

Returns:

The Gauge object, or a mock if necessary.

gaugeGet

public static double gaugeGet(java.lang.Object gauge)

Gets the current value stored in the Prometheus Gauge, if possible.

Parameters:

gauge - The instance of the gauge

Returns:

The value of the Gauge as a Double

gaugeSet

public static void gaugeSet(java.lang.Object gauge,
                            double val)

Sets the Prometheus Gauge to a given value, if possible.

gaugeInc

public static void gaugeInc(java.lang.Object gauge)

Increments the value in the Prometheus Gauge by 1, if possible.

gaugeDec

public static void gaugeDec(java.lang.Object gauge)

Decrements the value in the Prometheus Gauge by 1, if possible.

counterBuild

public static java.lang.Object counterBuild(java.lang.String name,
                                            java.lang.String help)

Builds a new Prometheus Counter metric, if possible.

Parameters:

name - The name of the metric

help - The help string of the metric

Returns:

The Prometheus counter, or a mock if necessary.

counterInc

public static void counterInc(java.lang.Object counter)

Increments the value in the Prometheus Counter by 1, if possible. We never do any other operations to Counter except increment it (for now)

havePrometheus

public static boolean havePrometheus()

Getter method for this.havePrometheus