io.micronaut.scheduling.instrument

Interface InvocationInstrumenter

public interface InvocationInstrumenter

An interface for invocation instrumentation.

Since:

1.3

Author:

Denis Stepanov, graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static InvocationInstrumenter	NOOP Noop implementation if InvocationInstrumenter.

Method Summary

Modifier and Type	Method and Description
static InvocationInstrumenter	combine(Collection<InvocationInstrumenter> invocationInstrumenters) Combines multiple instrumenters into one.
static <V> Callable<V>	instrument(Callable<V> callable, Collection<InvocationInstrumenter> invocationInstrumenters) Wraps Callable with instrumentation invocations.
static <V> Callable<V>	instrument(Callable<V> callable, InvocationInstrumenter invocationInstrumenter) Wraps Callable with instrumentation invocations.
static Executor	instrument(Executor executor, InvocationInstrumenter invocationInstrumenter) Wraps the executor so that every tasks submitted to it will be executed instrumented with the given invocationInstrumenter.
static Runnable	instrument(Runnable runnable, Collection<InvocationInstrumenter> invocationInstrumenters) Wraps Runnable with instrumentation invocations.
static Runnable	instrument(Runnable runnable, InvocationInstrumenter invocationInstrumenter) Wraps Runnable with instrumentation invocations.
Instrumentation	newInstrumentation()

Field Detail

NOOP

static final InvocationInstrumenter NOOP

Noop implementation if InvocationInstrumenter.

Method Detail

newInstrumentation

@NonNull
Instrumentation newInstrumentation()

Returns:

a one-time Instrumentation instance which to be used in a try-with-resources to do the instrumentation. To force cleanup invoke Instrumentation.forceCleanup() on the retuned instance.

Since:

2.0

combine

@NonNull
static InvocationInstrumenter combine(Collection<InvocationInstrumenter> invocationInstrumenters)

Combines multiple instrumenters into one.

Parameters:

invocationInstrumenters - instrumenters to combine

Returns:

new instrumenter

instrument

@NonNull
static Runnable instrument(@NonNull
                                    Runnable runnable,
                                    Collection<InvocationInstrumenter> invocationInstrumenters)

Wraps Runnable with instrumentation invocations.

Parameters:

runnable - Runnable to be wrapped

invocationInstrumenters - instrumenters to be used

Returns:

wrapper

instrument

@NonNull
static <V> Callable<V> instrument(@NonNull
                                           Callable<V> callable,
                                           Collection<InvocationInstrumenter> invocationInstrumenters)

Wraps Callable with instrumentation invocations.

Type Parameters:

V - callable generic param

Parameters:

callable - Callable to be wrapped

invocationInstrumenters - instrumenters to be used

Returns:

wrapper

instrument

@NonNull
static Runnable instrument(@NonNull
                                    Runnable runnable,
                                    InvocationInstrumenter invocationInstrumenter)

Wraps Runnable with instrumentation invocations.

Parameters:

runnable - Runnable to be wrapped

invocationInstrumenter - instrumenter to be used

Returns:

wrapper

instrument

@NonNull
static <V> Callable<V> instrument(@NonNull
                                           Callable<V> callable,
                                           InvocationInstrumenter invocationInstrumenter)

Wraps Callable with instrumentation invocations.

Type Parameters:

V - callable generic param

Parameters:

callable - Callable to be wrapped

invocationInstrumenter - instrumenter to be used

Returns:

wrapper

instrument

static Executor instrument(@NonNull
                           Executor executor,
                           @NonNull
                           InvocationInstrumenter invocationInstrumenter)

Wraps the executor so that every tasks submitted to it will be executed instrumented with the given invocationInstrumenter. Execution itself will be delegated to the underlying executor, but it has to be considered that all instrumentation will be done with this very same invocationInstrumenter instance. This is especially useful when follow-up actions of a given task need to be registered, where a new instrumenter, thus a new wrapped executor instance belongs to each task.

The returned wrapped executor be of subtype ExecutorService or ScheduledExecutorService if the input executor instance implemented those interfaces.

Parameters:

executor - the executor to wrap

invocationInstrumenter - the instrumenter to be used upon task executions with the returned executor

Returns:

the wrapped executor