de.codecentric.batch.metrics

Class MetricsListener

java.lang.Object

org.springframework.batch.core.listener.StepExecutionListenerSupport

de.codecentric.batch.metrics.MetricsListener

All Implemented Interfaces:

org.springframework.batch.core.JobExecutionListener, org.springframework.batch.core.StepExecutionListener, org.springframework.batch.core.StepListener, org.springframework.core.Ordered

public class MetricsListener
extends org.springframework.batch.core.listener.StepExecutionListenerSupport
implements org.springframework.core.Ordered, org.springframework.batch.core.JobExecutionListener

This listener exports all metrics with the prefix 'counter.batch.{jobName}.{jobExecutionId}.{stepName} and all gauges with the prefix 'gauge.batch.{jobName}.{stepName}' to the Step- ExecutionContext without the prefix. All metrics and gauges are logged as well. For overriding the default format of the logging a component implementing MetricsOutputFormatter may be added to the ApplicationContext. Counters are cumulated over several StepExecutions belonging to one Step in one JobInstance, important for restarted jobs.

Author:

Tobias Flohre, Dennis Schulte

Field Summary

Fields

Modifier and Type	Field and Description
static String	METRIC_NAME

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
MetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Summary

Modifier and Type	Method and Description
void	afterJob(org.springframework.batch.core.JobExecution jobExecution)
org.springframework.batch.core.ExitStatus	afterStep(org.springframework.batch.core.StepExecution stepExecution)
void	beforeJob(org.springframework.batch.core.JobExecution jobExecution)
int	getOrder()
void	setMetricsOutputFormatter(MetricsOutputFormatter metricsOutputFormatter)

Methods inherited from class org.springframework.batch.core.listener.StepExecutionListenerSupport

beforeStep

Methods inherited from class java.lang.Object

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

Field Detail

METRIC_NAME

public static final String METRIC_NAME

See Also:

Constant Field Values

Constructor Detail

MetricsListener

public MetricsListener(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Method Detail

beforeJob

public void beforeJob(org.springframework.batch.core.JobExecution jobExecution)

Specified by:

beforeJob in interface org.springframework.batch.core.JobExecutionListener

afterStep

public org.springframework.batch.core.ExitStatus afterStep(org.springframework.batch.core.StepExecution stepExecution)

Specified by:

afterStep in interface org.springframework.batch.core.StepExecutionListener

Overrides:

afterStep in class org.springframework.batch.core.listener.StepExecutionListenerSupport

afterJob

public void afterJob(org.springframework.batch.core.JobExecution jobExecution)

Specified by:

afterJob in interface org.springframework.batch.core.JobExecutionListener

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered

setMetricsOutputFormatter

public void setMetricsOutputFormatter(MetricsOutputFormatter metricsOutputFormatter)