fr.gouv.vitam.common.metrics

Class VitamMetrics

java.lang.Object

fr.gouv.vitam.common.metrics.VitamMetrics

public class VitamMetrics
extends Object

A basic class that acts as a container between a VitamMetricRegistry and a ScheduledReporter. This class provides an access to the VitamMetricRegistry and the possibility to start/stop the reporting.

Constructor Summary

Constructors

Constructor and Description
VitamMetrics(VitamMetricsType type, VitamMetricsConfiguration configuration) A constructor to instantiate a VitamMetrics with the configuration object VitamMetricsConfiguration .

Method Summary

Modifier and Type	Method and Description
VitamMetricRegistry	getRegistry() Return the underlying metric registry
VitamMetricsType	getType() Return the type of this VitamMetrics
boolean	isReporting() Indicates whether or not this VitamMetrics is currently reporting.
void	start() Start the reporting.
void	stop() Stop the reporting.

Methods inherited from class java.lang.Object

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

Constructor Detail

VitamMetrics

public VitamMetrics(VitamMetricsType type,
                    VitamMetricsConfiguration configuration)

A constructor to instantiate a VitamMetrics with the configuration object VitamMetricsConfiguration . The configuration object must be returned from the method {link VitamMetricsConfiguration#getMetricsConfigurations()

Parameters:

type -

configuration - VitamMetricsConfiguration

Method Detail

getRegistry

public VitamMetricRegistry getRegistry()

Return the underlying metric registry

Returns:

VitamMetricRegistry

getType

public VitamMetricsType getType()

Return the type of this VitamMetrics

Returns:

VitamMetricsType

isReporting

public boolean isReporting()

Indicates whether or not this VitamMetrics is currently reporting.

Returns:

boolean

start

public final void start()

Start the reporting.

stop

public final void stop()

Stop the reporting.