Package io.camunda.spring.client.metrics

Interface MetricsRecorder

All Known Implementing Classes:

DefaultNoopMetricsRecorder, MicrometerMetricsRecorder, SimpleMetricsRecorder

public interface MetricsRecorder

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_ACTIVATED
static final String	ACTION_BPMN_ERROR
static final String	ACTION_COMPLETED
static final String	ACTION_FAILED
static final String	METRIC_NAME_JOB

Method Summary

Modifier and Type	Method	Description
void	executeWithTimer(String metricName, String jobType, Runnable methodToExecute)	Execute the given runnable and measure the execution time
default void	increase(String metricName, String action, String type)	Increase the counter for the given metric name, action and type
void	increase(String metricName, String action, String type, int count)	Increase the counter for the given metric name, action and type

Field Details

METRIC_NAME_JOB

static final String METRIC_NAME_JOB

See Also:

• Constant Field Values

ACTION_ACTIVATED

static final String ACTION_ACTIVATED

See Also:

• Constant Field Values

ACTION_COMPLETED

static final String ACTION_COMPLETED

See Also:

• Constant Field Values

ACTION_FAILED

static final String ACTION_FAILED

See Also:

• Constant Field Values

ACTION_BPMN_ERROR

static final String ACTION_BPMN_ERROR

See Also:

• Constant Field Values

Method Details

increase

default void increase(String metricName,
 String action,
 String type)

Increase the counter for the given metric name, action and type

Parameters:

metricName - - the name of the metric

action - - event type within the metric, e.g. activated, completed, failed, bpmn-error

type - - type of the job the metric is for

increase

void increase(String metricName,
 String action,
 String type,
 int count)

Increase the counter for the given metric name, action and type

Parameters:

metricName - - the name of the metric

action - - event type within the metric, e.g. activated, completed, failed, bpmn-error

type - - type of the job the metric is for

count - - the amount to increase the metric by

executeWithTimer

void executeWithTimer(String metricName,
 String jobType,
 Runnable methodToExecute)

Execute the given runnable and measure the execution time

Note: the provided runnable is executed synchronously

Parameters:

metricName - - the name of the metric

jobType - - type of the job the metric is for

methodToExecute - - the method to execute