io.mats3.intercept.micrometer

Class MatsMicrometerInterceptor

java.lang.Object

io.mats3.intercept.micrometer.MatsMicrometerInterceptor

All Implemented Interfaces:

io.mats3.api.intercept.MatsInitiateInterceptor, io.mats3.api.intercept.MatsMetricsInterceptor, io.mats3.api.intercept.MatsStageInterceptor

public class MatsMicrometerInterceptor
extends java.lang.Object
implements io.mats3.api.intercept.MatsMetricsInterceptor, io.mats3.api.intercept.MatsInitiateInterceptor, io.mats3.api.intercept.MatsStageInterceptor

An interceptor that instruments a MatsFactory with metrics using the (Spring) Micrometer framework. If you provide a MeterRegistry, it will employ this to create the metrics on, otherwise it employs the Metrics.globalRegistry.

Note: This interceptor (Micrometer Metrics) has special support in JmsMatsFactory: If present on the classpath, it is automatically installed using the install(MatsInterceptableMatsFactory) install method. This implies that it employs the Micrometer 'globalRegistry'. If you rather want to supply a specific registry, then install a different instance using the install(MatsInterceptableMatsFactory, MeterRegistry) method - the JmsMatsFactory will then remove the automatically installed, since it implements the special marker-interface MatsMetricsInterceptor of which there can only be one instance installed.

Notice the class MatsMicrometerInterceptor.SuggestedTimingHistogramsMeterFilter. You may apply this as such:
Metrics.globalRegistry.config().meterFilter(new SuggestedTimingHistogramsMeterFilter());
.. or you may apply any other distribution or histogram configuration using the MeterFilter logic of Micrometer.

See Also:

MatsMicrometerInterceptor.SuggestedTimingHistogramsMeterFilter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MatsMicrometerInterceptor.SuggestedTimingHistogramsMeterFilter A MeterFilter that applies a hopefully reasonable histogram to all timing meters.

Nested classes/interfaces inherited from interface io.mats3.api.intercept.MatsInitiateInterceptor

io.mats3.api.intercept.MatsInitiateInterceptor.InitiateCompletedContext, io.mats3.api.intercept.MatsInitiateInterceptor.InitiateInterceptContext, io.mats3.api.intercept.MatsInitiateInterceptor.InitiateInterceptOutgoingMessagesContext, io.mats3.api.intercept.MatsInitiateInterceptor.InitiateInterceptUserLambdaContext, io.mats3.api.intercept.MatsInitiateInterceptor.InitiateStartedContext, io.mats3.api.intercept.MatsInitiateInterceptor.MatsInitiateInterceptOutgoingMessages, io.mats3.api.intercept.MatsInitiateInterceptor.MatsInitiateInterceptUserLambda

Nested classes/interfaces inherited from interface io.mats3.api.intercept.MatsStageInterceptor

io.mats3.api.intercept.MatsStageInterceptor.MatsStageInterceptOutgoingMessages, io.mats3.api.intercept.MatsStageInterceptor.MatsStageInterceptUserLambda, io.mats3.api.intercept.MatsStageInterceptor.StageCommonContext, io.mats3.api.intercept.MatsStageInterceptor.StageCompletedContext, io.mats3.api.intercept.MatsStageInterceptor.StageInterceptContext, io.mats3.api.intercept.MatsStageInterceptor.StageInterceptOutgoingMessageContext, io.mats3.api.intercept.MatsStageInterceptor.StageInterceptUserLambdaContext, io.mats3.api.intercept.MatsStageInterceptor.StagePreprocessAndDeserializeErrorContext, io.mats3.api.intercept.MatsStageInterceptor.StageReceivedContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COUNT_EXEC_MSGS_OUT_DESC
static java.lang.String	COUNT_EXEC_MSGS_OUT_NAME
static java.lang.String	LOG_PREFIX
static int	MAX_NUMBER_OF_METRICS This is a cardinality-explosion-avoidance limit in case of wrongly used initiatorIds.
static java.lang.String	METRIC_EXEC_OPS_MEASURE_PREFIX
static java.lang.String	METRIC_EXEC_OPS_TIMING_PREFIX
static java.lang.String	SIZE_MSG_ENVELOPE_DESC
static java.lang.String	SIZE_MSG_ENVELOPE_NAME
static java.lang.String	SIZE_MSG_WIRE_DESC
static java.lang.String	SIZE_MSG_WIRE_NAME
static java.lang.String	TIMER_EXEC_DB_COMMIT_DESC
static java.lang.String	TIMER_EXEC_DB_COMMIT_NAME
static java.lang.String	TIMER_EXEC_MSGS_OUT_DESC
static java.lang.String	TIMER_EXEC_MSGS_OUT_NAME
static java.lang.String	TIMER_EXEC_MSGSYS_COMMIT_DESC
static java.lang.String	TIMER_EXEC_MSGSYS_COMMIT_NAME
static java.lang.String	TIMER_EXEC_TOTAL_DESC
static java.lang.String	TIMER_EXEC_TOTAL_NAME
static java.lang.String	TIMER_EXEC_USER_LAMBDA_DESC
static java.lang.String	TIMER_EXEC_USER_LAMBDA_NAME
static java.lang.String	TIMER_MSG_MSGSYS_SEND_DESC
static java.lang.String	TIMER_MSG_MSGSYS_SEND_NAME
static java.lang.String	TIMER_MSG_TOTAL_DESC
static java.lang.String	TIMER_MSG_TOTAL_NAME

Method Summary

Modifier and Type	Method and Description
void	initiateCompleted(io.mats3.api.intercept.MatsInitiateInterceptor.InitiateCompletedContext ctx)
static MatsMicrometerInterceptor	install(io.mats3.api.intercept.MatsInterceptableMatsFactory matsInterceptableMatsFactory) Installs a singleton instance of MatsMicrometerInterceptor which employs the Metrics.globalRegistry, on the provided MatsInterceptableMatsFactory.
static MatsMicrometerInterceptor	install(io.mats3.api.intercept.MatsInterceptableMatsFactory matsInterceptableMatsFactory, io.micrometer.core.instrument.MeterRegistry meterRegistry) Creates a MatsMicrometerInterceptor employing the provided MeterRegistry, and installs it as a singleton on the provided MatsInterceptableMatsFactory
void	stageCompleted(io.mats3.api.intercept.MatsStageInterceptor.StageCompletedContext ctx)
void	stageReceived(io.mats3.api.intercept.MatsStageInterceptor.StageReceivedContext ctx)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.mats3.api.intercept.MatsInitiateInterceptor

initiateStarted

Methods inherited from interface io.mats3.api.intercept.MatsStageInterceptor

stagePreprocessAndDeserializeError

Field Detail

LOG_PREFIX

public static final java.lang.String LOG_PREFIX

See Also:

Constant Field Values

TIMER_EXEC_TOTAL_NAME

public static final java.lang.String TIMER_EXEC_TOTAL_NAME

See Also:

Constant Field Values

TIMER_EXEC_TOTAL_DESC

public static final java.lang.String TIMER_EXEC_TOTAL_DESC

See Also:

Constant Field Values

TIMER_EXEC_USER_LAMBDA_NAME

public static final java.lang.String TIMER_EXEC_USER_LAMBDA_NAME

See Also:

Constant Field Values

TIMER_EXEC_USER_LAMBDA_DESC

public static final java.lang.String TIMER_EXEC_USER_LAMBDA_DESC

See Also:

Constant Field Values

TIMER_EXEC_MSGS_OUT_NAME

public static final java.lang.String TIMER_EXEC_MSGS_OUT_NAME

See Also:

Constant Field Values

TIMER_EXEC_MSGS_OUT_DESC

public static final java.lang.String TIMER_EXEC_MSGS_OUT_DESC

See Also:

Constant Field Values

COUNT_EXEC_MSGS_OUT_NAME

public static final java.lang.String COUNT_EXEC_MSGS_OUT_NAME

See Also:

Constant Field Values

COUNT_EXEC_MSGS_OUT_DESC

public static final java.lang.String COUNT_EXEC_MSGS_OUT_DESC

See Also:

Constant Field Values

TIMER_EXEC_DB_COMMIT_NAME

public static final java.lang.String TIMER_EXEC_DB_COMMIT_NAME

See Also:

Constant Field Values

TIMER_EXEC_DB_COMMIT_DESC

public static final java.lang.String TIMER_EXEC_DB_COMMIT_DESC

See Also:

Constant Field Values

TIMER_EXEC_MSGSYS_COMMIT_NAME

public static final java.lang.String TIMER_EXEC_MSGSYS_COMMIT_NAME

See Also:

Constant Field Values

TIMER_EXEC_MSGSYS_COMMIT_DESC

public static final java.lang.String TIMER_EXEC_MSGSYS_COMMIT_DESC

See Also:

Constant Field Values

METRIC_EXEC_OPS_TIMING_PREFIX

public static final java.lang.String METRIC_EXEC_OPS_TIMING_PREFIX

See Also:

Constant Field Values

METRIC_EXEC_OPS_MEASURE_PREFIX

public static final java.lang.String METRIC_EXEC_OPS_MEASURE_PREFIX

See Also:

Constant Field Values

TIMER_MSG_TOTAL_NAME

public static final java.lang.String TIMER_MSG_TOTAL_NAME

See Also:

Constant Field Values

TIMER_MSG_TOTAL_DESC

public static final java.lang.String TIMER_MSG_TOTAL_DESC

See Also:

Constant Field Values

TIMER_MSG_MSGSYS_SEND_NAME

public static final java.lang.String TIMER_MSG_MSGSYS_SEND_NAME

See Also:

Constant Field Values

TIMER_MSG_MSGSYS_SEND_DESC

public static final java.lang.String TIMER_MSG_MSGSYS_SEND_DESC

See Also:

Constant Field Values

SIZE_MSG_ENVELOPE_NAME

public static final java.lang.String SIZE_MSG_ENVELOPE_NAME

See Also:

Constant Field Values

SIZE_MSG_ENVELOPE_DESC

public static final java.lang.String SIZE_MSG_ENVELOPE_DESC

See Also:

Constant Field Values

SIZE_MSG_WIRE_NAME

public static final java.lang.String SIZE_MSG_WIRE_NAME

See Also:

Constant Field Values

SIZE_MSG_WIRE_DESC

public static final java.lang.String SIZE_MSG_WIRE_DESC

See Also:

Constant Field Values

MAX_NUMBER_OF_METRICS

public static final int MAX_NUMBER_OF_METRICS

This is a cardinality-explosion-avoidance limit in case of wrongly used initiatorIds. These are not supposed to be dynamic, but there is nothing hindering a user from creating a new initiatorId per initiation. Thus, if we go above a certain number of such entries, we stop adding.

Value is 200.

See Also:

Constant Field Values

Method Detail

install

public static MatsMicrometerInterceptor install(io.mats3.api.intercept.MatsInterceptableMatsFactory matsInterceptableMatsFactory,
                                                io.micrometer.core.instrument.MeterRegistry meterRegistry)

Creates a MatsMicrometerInterceptor employing the provided MeterRegistry, and installs it as a singleton on the provided MatsInterceptableMatsFactory

Parameters:

matsInterceptableMatsFactory - the MatsInterceptable to install on (probably a MatsFactory.

meterRegistry - the Micrometer MeterRegistry to create meters on.

Returns:

the MatsMicrometerInterceptor instance which was installed as singleton.

install

public static MatsMicrometerInterceptor install(io.mats3.api.intercept.MatsInterceptableMatsFactory matsInterceptableMatsFactory)

Installs a singleton instance of MatsMicrometerInterceptor which employs the Metrics.globalRegistry, on the provided MatsInterceptableMatsFactory.

Parameters:

matsInterceptableMatsFactory - the MatsInterceptable to install on (probably a MatsFactory.

Returns:

the MatsMicrometerInterceptor instance which was installed as singleton.

initiateCompleted

public void initiateCompleted(io.mats3.api.intercept.MatsInitiateInterceptor.InitiateCompletedContext ctx)

Specified by:

initiateCompleted in interface io.mats3.api.intercept.MatsInitiateInterceptor

stageReceived

public void stageReceived(io.mats3.api.intercept.MatsStageInterceptor.StageReceivedContext ctx)

Specified by:

stageReceived in interface io.mats3.api.intercept.MatsStageInterceptor

stageCompleted

public void stageCompleted(io.mats3.api.intercept.MatsStageInterceptor.StageCompletedContext ctx)

Specified by:

stageCompleted in interface io.mats3.api.intercept.MatsStageInterceptor