com.hazelcast.internal.metrics.impl

Class MetricsService

java.lang.Object

com.hazelcast.internal.metrics.impl.MetricsService

All Implemented Interfaces:

ManagedService, LiveOperationsTracker

public class MetricsService
extends Object
implements ManagedService, LiveOperationsTracker

Service collecting the Metrics periodically and publishes them via MetricsPublishers.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Constructor Summary

Constructors

Constructor and Description
MetricsService(NodeEngine nodeEngine)
MetricsService(NodeEngine nodeEngine, Supplier<MetricsRegistry> metricsRegistrySupplier)

Method Summary

Modifier and Type	Method and Description
LiveOperationRegistry	getLiveOperationRegistry()
void	init(NodeEngine nodeEngine, Properties properties) Initializes this service.
void	populate(LiveOperations liveOperations) Populate the LiveOperations
CompletableFuture<ConcurrentArrayRingbuffer.RingbufferSlice<Map.Entry<Long,byte[]>>>	readMetrics(long startSequence) Read metrics from the journal from the given sequence.
void	registerPublisher(Function<NodeEngine,MetricsPublisher> registerFunction) Register a custom MetricsPublisher implementation with a register function that takes NodeEngine as input letting the caller to optionally initialize the publisher returned from the function.
void	reset() Resets this service back to its initial state.
void	shutdown(boolean terminate) Shuts down this service.

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

MetricsService

public MetricsService(NodeEngine nodeEngine)

MetricsService

public MetricsService(NodeEngine nodeEngine,
                      Supplier<MetricsRegistry> metricsRegistrySupplier)

Method Detail

init

public void init(NodeEngine nodeEngine,
                 Properties properties)

Description copied from interface: ManagedService

Initializes this service.

Specified by:

init in interface ManagedService

Parameters:

nodeEngine - the NodeEngine that this service belongs to

properties - the Properties (can be used to pass settings to the service)

registerPublisher

public void registerPublisher(Function<NodeEngine,MetricsPublisher> registerFunction)

Register a custom MetricsPublisher implementation with a register function that takes NodeEngine as input letting the caller to optionally initialize the publisher returned from the function.

Parameters:

registerFunction - The function that returns with the MetricsPublisher instance.

getLiveOperationRegistry

public LiveOperationRegistry getLiveOperationRegistry()

populate

public void populate(LiveOperations liveOperations)

Description copied from interface: LiveOperationsTracker

Populate the LiveOperations

Specified by:

populate in interface LiveOperationsTracker

Parameters:

liveOperations - the LiveOperations to populate.

readMetrics

public CompletableFuture<ConcurrentArrayRingbuffer.RingbufferSlice<Map.Entry<Long,byte[]>>> readMetrics(long startSequence)

Read metrics from the journal from the given sequence.

Parameters:

startSequence - The sequence start reading the metrics with.

reset

public void reset()

Description copied from interface: ManagedService

Resets this service back to its initial state.

TODO: what is the purpose of reset

Specified by:

reset in interface ManagedService

shutdown

public void shutdown(boolean terminate)

Description copied from interface: ManagedService

Shuts down this service.

TODO: what is the purpose of the terminate variable

Specified by:

shutdown in interface ManagedService

Parameters:

terminate - true to shut down this service