io.micrometer.core.instrument.binder.jvm

Class ExecutorServiceMetrics

java.lang.Object

io.micrometer.core.instrument.binder.jvm.ExecutorServiceMetrics

All Implemented Interfaces:

MeterBinder

@NonNullApi
 @NonNullFields
public class ExecutorServiceMetrics
extends Object
implements MeterBinder

Monitors the status of executor service pools. Does not record timings on operations executed in the ExecutorService, as this requires the instance to be wrapped. Timings are provided separately by wrapping the executor service with TimedExecutorService.

Constructor Summary

Constructors

Constructor and Description
ExecutorServiceMetrics(ExecutorService executorService, String executorServiceName, Iterable<Tag> tags)

Method Summary

Modifier and Type	Method and Description
void	bindTo(MeterRegistry registry)
static ExecutorService	monitor(MeterRegistry registry, ExecutorService executor, String executorServiceName, Iterable<Tag> tags) Record metrics on the use of an ExecutorService.
static ExecutorService	monitor(MeterRegistry registry, ExecutorService executor, String executorServiceName, Tag... tags) Record metrics on the use of an ExecutorService.
static Executor	monitor(MeterRegistry registry, Executor executor, String executorName, Iterable<Tag> tags) Record metrics on the use of an Executor.
static Executor	monitor(MeterRegistry registry, Executor executor, String executorName, Tag... tags) Record metrics on the use of an Executor.
static ScheduledExecutorService	monitor(MeterRegistry registry, ScheduledExecutorService executor, String executorServiceName, Iterable<Tag> tags) Record metrics on the use of a ScheduledExecutorService.
static ScheduledExecutorService	monitor(MeterRegistry registry, ScheduledExecutorService executor, String executorServiceName, Tag... tags) Record metrics on the use of a ScheduledExecutorService.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutorServiceMetrics

public ExecutorServiceMetrics(@Nullable
                              ExecutorService executorService,
                              String executorServiceName,
                              Iterable<Tag> tags)

Method Detail

monitor

public static Executor monitor(MeterRegistry registry,
                               Executor executor,
                               String executorName,
                               Iterable<Tag> tags)

Record metrics on the use of an Executor.

Parameters:

registry - The registry to bind metrics to.

executor - The executor to instrument.

executorName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented executor, proxied.

monitor

public static Executor monitor(MeterRegistry registry,
                               Executor executor,
                               String executorName,
                               Tag... tags)

Record metrics on the use of an Executor.

Parameters:

registry - The registry to bind metrics to.

executor - The executor to instrument.

executorName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented executor, proxied.

monitor

public static ExecutorService monitor(MeterRegistry registry,
                                      ExecutorService executor,
                                      String executorServiceName,
                                      Iterable<Tag> tags)

Record metrics on the use of an ExecutorService.

Parameters:

registry - The registry to bind metrics to.

executor - The executor to instrument.

executorServiceName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented executor, proxied.

monitor

public static ExecutorService monitor(MeterRegistry registry,
                                      ExecutorService executor,
                                      String executorServiceName,
                                      Tag... tags)

Record metrics on the use of an ExecutorService.

Parameters:

registry - The registry to bind metrics to.

executor - The executor to instrument.

executorServiceName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented executor, proxied.

monitor

public static ScheduledExecutorService monitor(MeterRegistry registry,
                                               ScheduledExecutorService executor,
                                               String executorServiceName,
                                               Iterable<Tag> tags)

Record metrics on the use of a ScheduledExecutorService.

Parameters:

registry - The registry to bind metrics to.

executor - The scheduled executor to instrument.

executorServiceName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented scheduled executor, proxied.

Since:

1.3.0

monitor

public static ScheduledExecutorService monitor(MeterRegistry registry,
                                               ScheduledExecutorService executor,
                                               String executorServiceName,
                                               Tag... tags)

Record metrics on the use of a ScheduledExecutorService.

Parameters:

registry - The registry to bind metrics to.

executor - The scheduled executor to instrument.

executorServiceName - Will be used to tag metrics with "name".

tags - Tags to apply to all recorded metrics.

Returns:

The instrumented scheduled executor, proxied.

Since:

1.3.0

bindTo

public void bindTo(MeterRegistry registry)

Specified by:

bindTo in interface MeterBinder