org.imixs.workflow.engine

Class MetricService

java.lang.Object

org.imixs.workflow.engine.MetricService

@ApplicationScoped
public class MetricService
extends Object

The Imixs MetricSerivce is a monitoring resource for Imixs-Workflow in the prometheus format. The MetricService is based on Microprofile 2.2 and MP-Metric-API 2.2

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

The service provides counter metrics for document access and processed workitems. A counter will always increase. To extract the values in prometheus use the rate function - Example:

rate(http_requests_total[5m])

The service expects MP Metrics v2.0. A warning is logged if corresponding version is missing.

To enable the metric service the imixs.property ... must be set to true

Version:

1.0

Author:

rsoika

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_DOCUMENTS_TOTAL
static String	METRIC_WORKITEMS_TOTAL

Constructor Summary

Constructors

Constructor and Description
MetricService()

Method Summary

Modifier and Type	Method and Description
void	onDocumentEvent(DocumentEvent documentEvent) DocumentEvent listener to generate a metric.
void	onProcessingEvent(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

Field Detail

METRIC_DOCUMENTS_TOTAL

public static final String METRIC_DOCUMENTS_TOTAL

See Also:

Constant Field Values

METRIC_WORKITEMS_TOTAL

public static final String METRIC_WORKITEMS_TOTAL

See Also:

Constant Field Values

Constructor Detail

MetricService

public MetricService()

Method Detail

onProcessingEvent

public void onProcessingEvent(@Observes
                              ProcessingEvent processingEvent)
                       throws AccessDeniedException

ProcessingEvent listener to generate a metric.

Parameters:

processingEvent -

Throws:

AccessDeniedException

onDocumentEvent

public void onDocumentEvent(@Observes
                            DocumentEvent documentEvent)
                     throws AccessDeniedException

DocumentEvent listener to generate a metric.

Parameters:

documentEvent -

Throws:

AccessDeniedException