Package com.intergral.deep.plugin

Class PrometheusMetricsPlugin

java.lang.Object

com.intergral.deep.plugin.PrometheusMetricsPlugin

All Implemented Interfaces:

IMetricProcessor, IConditional, IDeepPlugin, Ordered

public class PrometheusMetricsPlugin
extends Object
implements IDeepPlugin, IConditional, IMetricProcessor, Ordered

This plugin provides the ability to post tracepoint generated metric to prometheus.

This plugin is loaded by the Deep module and not the agent. As we need to be loaded in the app class path and not the boot class path.

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsPlugin()

Method Summary

Modifier and Type	Method	Description
void	counter(String name, Map<String,Object> labels, String namespace, String help, String unit, Double value)	Process a counter type metric.
void	gauge(String name, Map<String,Object> labels, String namespace, String help, String unit, Double value)	Process a gauge type metric.
void	histogram(String name, Map<String,Object> labels, String namespace, String help, String unit, Double value)	Process a histogram type metric.
boolean	isActive()	Should determine if the plugin is active.
void	summary(String name, Map<String,Object> labels, String namespace, String help, String unit, Double value)	Process a summary type metric.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.intergral.deep.agent.api.spi.IDeepPlugin

configure

Methods inherited from interface com.intergral.deep.agent.api.spi.Ordered

order

Constructor Detail

PrometheusMetricsPlugin

public PrometheusMetricsPlugin()

Method Detail

isActive

public boolean isActive()

Description copied from interface: IConditional

Should determine if the plugin is active.

Specified by:

isActive in interface IConditional

Returns:

true if and only if the plugins is active, else false

counter

public void counter(String name,
                    Map<String,Object> labels,
                    String namespace,
                    String help,
                    String unit,
                    Double value)

Description copied from interface: IMetricProcessor

Process a counter type metric.

Specified by:

counter in interface IMetricProcessor

Parameters:

name - the name of the metric

labels - the labels attached to the metric

namespace - the namespace the metric should be in

help - the help statement for the metric

unit - the unit for the metric

value - the value to post to the metric

gauge

public void gauge(String name,
                  Map<String,Object> labels,
                  String namespace,
                  String help,
                  String unit,
                  Double value)

Description copied from interface: IMetricProcessor

Process a gauge type metric.

Specified by:

gauge in interface IMetricProcessor

Parameters:

name - the name of the metric

labels - the labels attached to the metric

namespace - the namespace the metric should be in

help - the help statement for the metric

unit - the unit for the metric

value - the value to post to the metric

histogram

public void histogram(String name,
                      Map<String,Object> labels,
                      String namespace,
                      String help,
                      String unit,
                      Double value)

Description copied from interface: IMetricProcessor

Process a histogram type metric.

Specified by:

histogram in interface IMetricProcessor

Parameters:

name - the name of the metric

labels - the labels attached to the metric

namespace - the namespace the metric should be in

help - the help statement for the metric

unit - the unit for the metric

value - the value to post to the metric

summary

public void summary(String name,
                    Map<String,Object> labels,
                    String namespace,
                    String help,
                    String unit,
                    Double value)

Description copied from interface: IMetricProcessor

Process a summary type metric.

Specified by:

summary in interface IMetricProcessor

Parameters:

name - the name of the metric

labels - the labels attached to the metric

namespace - the namespace the metric should be in

help - the help statement for the metric

unit - the unit for the metric

value - the value to post to the metric