com.couchbase.client.core.metrics

Class AbstractMetricsCollector

java.lang.Object

com.couchbase.client.core.metrics.AbstractMetricsCollector

All Implemented Interfaces:

MetricsCollector

Direct Known Subclasses:

AbstractLatencyMetricsCollector, RuntimeMetricsCollector

public abstract class AbstractMetricsCollector
extends Object
implements MetricsCollector

A common base class for all metrics collectors which emit events.

Since:

1.2.0

Author:

Michael Nitschinger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMetricsCollector(EventBus eventBus, Scheduler scheduler, MetricsCollectorConfig config)

Method Summary

Modifier and Type	Method and Description
MetricsCollectorConfig	config() Its high-level configuration.
protected abstract CouchbaseEvent	generateCouchbaseEvent() Generate the actual CouchbaseEvent to emit on every interval.
boolean	isEnabled() True if this collector actually emits something.
boolean	shutdown() Shuts down the collector (non-reversible) and frees bound resources.
void	triggerEmit() Triggers the immediate emission of whatever is currently collected.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMetricsCollector

protected AbstractMetricsCollector(EventBus eventBus,
                                   Scheduler scheduler,
                                   MetricsCollectorConfig config)

Method Detail

generateCouchbaseEvent

protected abstract CouchbaseEvent generateCouchbaseEvent()

Generate the actual CouchbaseEvent to emit on every interval.

config

public MetricsCollectorConfig config()

Description copied from interface: MetricsCollector

Its high-level configuration.

Specified by:

config in interface MetricsCollector

shutdown

public boolean shutdown()

Description copied from interface: MetricsCollector

Shuts down the collector (non-reversible) and frees bound resources.

Specified by:

shutdown in interface MetricsCollector

isEnabled

public boolean isEnabled()

Description copied from interface: MetricsCollector

True if this collector actually emits something.

Specified by:

isEnabled in interface MetricsCollector

triggerEmit

public void triggerEmit()

Description copied from interface: MetricsCollector

Triggers the immediate emission of whatever is currently collected. Useful for testing.

Specified by:

triggerEmit in interface MetricsCollector