com.tibco.tea.agent.metrics

Interface MetricsRegistry

public interface MetricsRegistry

MetricsRegistry is registry of all the metrics managed by the base agent.

MetricsRegistry provides a series of methods for creating all the supported types of metrics. These methods create the desired metric, store the metric in the registry and then return the newly created metric.

Example:

 MetricsRegistry metricsRegistry = teaAgent.getMetricsRegistry();
 Counter counter = metricsRegistry.createGauge(HelloWorld.SERVER, "server1", "request-count", "Requests");
 

Method Summary

Methods

Modifier and Type	Method and Description
Counter	createCounter(MetricIdentifier counterIdentifier) Creates an instance of a Counter using the specified metric identifier.
Counter	createCounter(String objectType, String objectKey, String counterName, String counterDesc) Creates an instance of a Counter.
Counter	createCounter(String objectType, String objectKey, String counterName, String counterDesc, String metricUnit) Creates an instance of a Counter.
Gauge	createGauge(MetricIdentifier gaugeIdentifier, GaugeValueProvider<?> gaugeValueProvider)
Gauge	createGauge(String objectType, String objectKey, String gaugeName, String gaugeDesc, GaugeValueProvider<?> gaugeValueProvider) Creates an instance of a Gauge.
Gauge	createGauge(String objectType, String objectKey, String gaugeName, String gaugeDesc, String metricUnit, GaugeValueProvider<?> gaugeValueProvider) Creates an instance of a Gauge.
Meter	createMeter(MetricIdentifier meterIdentifier, TimeUnit rateUnit) Creates an instance of a Meter using the specified metric identifier.
Meter	createMeter(String objectType, String objectKey, String meterName, String meterDesc, String metricUnit, TimeUnit rateUnit) Creates an instance of a Meter.
Meter	createMeter(String objectType, String objectKey, String meterName, String meterDesc, TimeUnit rateUnit) Creates an instance of a Meter.
Timer	createTimer(MetricIdentifier timerIdentifier, TimeUnit durationUnit, TimeUnit rateUnit) Creates an instance of a Timer using the specified metric identifier.
Timer	createTimer(String objectType, String objectKey, String timerName, String timerDesc, String metricUnit, TimeUnit durationUnit, TimeUnit rateUnit) Creates an instance of a Timer.
Timer	createTimer(String objectType, String objectKey, String timerName, String timerDesc, TimeUnit durationUnit, TimeUnit rateUnit) Creates an instance of a Timer.
Metric	getMetric(MetricIdentifier metricIdentifier) Return the metric identified by the metricIdentifier
Metric	unregisterMetric(MetricIdentifier metricIdentifier) Remove the metric from the metrics registry.

Method Detail

createCounter

Counter createCounter(String objectType,
                    String objectKey,
                    String counterName,
                    String counterDesc)

Creates an instance of a Counter. The MetricIdentifier for the counter is created using the objectType, objectKey, counterName and counterDesc parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

counterName - name of the counter

counterDesc - description of the counter

Returns:

the created counter

createCounter

Counter createCounter(String objectType,
                    String objectKey,
                    String counterName,
                    String counterDesc,
                    String metricUnit)

Creates an instance of a Counter. The MetricIdentifier for the counter is created using the objectType, objectKey, counterName, counterDesc and metricUnit parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

counterName - name of the counter

counterDesc - description of the counter

metricUnit - Unit specifying what the counter is measuring. e.g. when measuring JVM memory, unit could be kilobytes.

Returns:

the created counter

createCounter

Counter createCounter(MetricIdentifier counterIdentifier)

Creates an instance of a Counter using the specified metric identifier.

Parameters:

counterIdentifier - identifier for the counter

Returns:

the created counter

createMeter

Meter createMeter(String objectType,
                String objectKey,
                String meterName,
                String meterDesc,
                TimeUnit rateUnit)

Creates an instance of a Meter. The MetricIdentifier for the meter is created using the objectType, objectKey, meterName and meterDesc parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

meterName - name of the meter

meterDesc - description of the meter

rateUnit - time unit for calculating the rate of events

Returns:

the created meter

createMeter

Meter createMeter(String objectType,
                String objectKey,
                String meterName,
                String meterDesc,
                String metricUnit,
                TimeUnit rateUnit)

Creates an instance of a Meter. The MetricIdentifier for the meter is created using the objectType, objectKey, meterName and meterDesc parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

meterName - name of the meter

meterDesc - description of the meter

metricUnit - Unit specifying what the meter is measuring. e.g. Requests/second.

rateUnit - time unit for calculating the rate of events

Returns:

the created meter

createMeter

Meter createMeter(MetricIdentifier meterIdentifier,
                TimeUnit rateUnit)

Creates an instance of a Meter using the specified metric identifier.

Parameters:

meterIdentifier - identifier for the meter

rateUnit - time unit for calculating the rate of events

Returns:

the created meter

createTimer

Timer createTimer(String objectType,
                String objectKey,
                String timerName,
                String timerDesc,
                TimeUnit durationUnit,
                TimeUnit rateUnit)

Creates an instance of a Timer. The MetricIdentifier for the meter is created using the objectType, objectKey, timerName, timerDesc and metricUnit parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

timerName - name of the timer

timerDesc - description of the timer

durationUnit - time unit for calculating the duration of the events

rateUnit - time unit for calculating the rate of events

Returns:

the created timer

createTimer

Timer createTimer(String objectType,
                String objectKey,
                String timerName,
                String timerDesc,
                String metricUnit,
                TimeUnit durationUnit,
                TimeUnit rateUnit)

Creates an instance of a Timer. The MetricIdentifier for the meter is created using the objectType, objectKey, timerName, timerDesc and metricUnit parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

timerName - name of the timer

timerDesc - description of the timer

metricUnit - Unit specifying what the timer is measuring. e.g. Requests.

durationUnit - time unit for calculating the duration of the events

rateUnit - time unit for calculating the rate of events

Returns:

the created timer

createTimer

Timer createTimer(MetricIdentifier timerIdentifier,
                TimeUnit durationUnit,
                TimeUnit rateUnit)

Creates an instance of a Timer using the specified metric identifier.

Parameters:

timerIdentifier - identifier for the timer

durationUnit - time unit for calculating the duration of the events

rateUnit - time unit for calculating the rate of events

Returns:

the created timer

createGauge

Gauge createGauge(String objectType,
                String objectKey,
                String gaugeName,
                String gaugeDesc,
                GaugeValueProvider<?> gaugeValueProvider)

Creates an instance of a Gauge. The MetricIdentifier for the gauge is created using the objectType, objectKey, gaugeName, gaugeDesc and metricUnit parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

gaugeName - name of the gauge

gaugeDesc - description of the gauge

gaugeValueProvider - implementation of GaugeValueProvider that would be used for retrieving the value

Returns:

the created gauge

createGauge

Gauge createGauge(String objectType,
                String objectKey,
                String gaugeName,
                String gaugeDesc,
                String metricUnit,
                GaugeValueProvider<?> gaugeValueProvider)

Creates an instance of a Gauge. The MetricIdentifier for the gauge is created using the objectType, objectKey, gaugeName, gaugeDesc and metricUnit parameters.

Parameters:

objectType - name of the TeaObjectType for the object instance

objectKey - key for identifying the object instance

gaugeName - name of the timer

gaugeDesc - description of the timer

metricUnit - Unit specifying what the timer is measuring. e.g. kilobytes.

gaugeValueProvider - implementation of GaugeValueProvider that would be used for retrieving the value

Returns:

the created gauge

createGauge

Gauge createGauge(MetricIdentifier gaugeIdentifier,
                GaugeValueProvider<?> gaugeValueProvider)

Parameters:

gaugeIdentifier - identifier for the gauge

gaugeValueProvider - implementation of GaugeValueProvider that would be used for retrieving the value

Returns:

the created gauge

unregisterMetric

Metric unregisterMetric(MetricIdentifier metricIdentifier)

Remove the metric from the metrics registry. No further data collection would be done for this metric.

Parameters:

metricIdentifier - identifier for the metric

Returns:

the metric

getMetric

Metric getMetric(MetricIdentifier metricIdentifier)

Return the metric identified by the metricIdentifier

Parameters:

metricIdentifier - identifier for the metric

Returns:

the metric