com.ibm.cloud.objectstorage.metrics

Class MetricCollector

java.lang.Object

com.ibm.cloud.objectstorage.metrics.MetricCollector

public abstract class MetricCollector
extends Object

Metric Collector SPI. This is a class instead of interface so in case of adding new methods in the future we can do that safetly without breaking any existing clients that implements this SPI.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MetricCollector.Factory Can be used to serve as a factory for the request metric collector.

Field Summary

Fields

Modifier and Type	Field and Description
static MetricCollector	NONE A convenient instance of a no-op request metric collector.

Constructor Summary

Constructors

Constructor and Description
MetricCollector()

Method Summary

Modifier and Type	Method and Description
abstract RequestMetricCollector	getRequestMetricCollector()
abstract ServiceMetricCollector	getServiceMetricCollector()
abstract boolean	isEnabled() Returns true if this collector is enabled; false otherwise.
abstract boolean	start() Starts the request metric collector.
abstract boolean	stop() Stops the request metric collector.

Methods inherited from class java.lang.Object

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

Field Detail

NONE

public static final MetricCollector NONE

A convenient instance of a no-op request metric collector.

Constructor Detail

MetricCollector

public MetricCollector()

Method Detail

start

public abstract boolean start()

Starts the request metric collector.

Returns:

true if the collector is successfully started; false otherwise.

stop

public abstract boolean stop()

Stops the request metric collector.

Returns:

true if the collector is successfully stopped; false if the collector is not running and therefore the call has no effect.

isEnabled

public abstract boolean isEnabled()

Returns true if this collector is enabled; false otherwise.

getRequestMetricCollector

public abstract RequestMetricCollector getRequestMetricCollector()

getServiceMetricCollector

public abstract ServiceMetricCollector getServiceMetricCollector()