org.imixs.adapter.prometheus

Class MetricService

java.lang.Object

org.imixs.adapter.prometheus.MetricService

public class MetricService
extends Object

The Imixs MetricSerivce is a monitoring resource for Prometheus.

A metric is generated when a Imixs ProcessingEvent or Imixs DocumentEvent is fired. The service exports metrics in prometheus text format.

See: https://prometheus.io/docs/instrumenting/exposition_formats/ https://www.oreilly.com/library/view/prometheus-up/9781492034131/ch04.html

To avoid dependencies, we implement the prometheus exposition text format you ourself.

Mainly the adaper proivdes counter metrics about processed workitems. A coutner will always increase. To extract the values in prometheus use the rate fuction - Exmaple: rate(http_requests_total[5m]) See: https://www.robustperception.io/how-does-a-prometheus-counter-work

Version:

1.0

Author:

rsoika

See Also:

http://www.adam-bien.com/roller/abien/entry/monitoring_java_ee_appservers_with http://www.adam-bien.com/roller/abien/entry/java_ee_6_observer_with

Constructor Summary

Constructors

Constructor and Description
MetricService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getMetrics() Get resource to export metrics in Prometheus text format Example: documents_total{method="load"} 66 workitems_processed_total{type="workitem",modelversion="auftrag-1.0.0",task="7000",event="10",workflowgroup="Auftrag",workflowstatus="Neuanlage"} 1
void	init()
void	onDocumentEvent(org.imixs.workflow.engine.DocumentEvent documentEvent) DocumentEvent listener to generate a metric.
void	onProcessingEvent(org.imixs.workflow.engine.ProcessingEvent processingEvent) ProcessingEvent listener to generate a metric.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricService

public MetricService()

Method Detail

init

@PostConstruct
public void init()

getMetrics

public javax.ws.rs.core.Response getMetrics()

Get resource to export metrics in Prometheus text format Example: documents_total{method="load"} 66 workitems_processed_total{type="workitem",modelversion="auftrag-1.0.0",task="7000",event="10",workflowgroup="Auftrag",workflowstatus="Neuanlage"} 1

onProcessingEvent

public void onProcessingEvent(@Observes
                              org.imixs.workflow.engine.ProcessingEvent processingEvent)
                       throws org.imixs.workflow.exceptions.AccessDeniedException

ProcessingEvent listener to generate a metric.

Parameters:

processingEvent -

Throws:

org.imixs.workflow.exceptions.AccessDeniedException

onDocumentEvent

public void onDocumentEvent(@Observes
                            org.imixs.workflow.engine.DocumentEvent documentEvent)
                     throws org.imixs.workflow.exceptions.AccessDeniedException

DocumentEvent listener to generate a metric.

Parameters:

documentEvent -

Throws:

org.imixs.workflow.exceptions.AccessDeniedException