org.apache.iotdb.metrics

Interface MetricManager

All Known Implementing Classes:

DoNothingMetricManager

public interface MetricManager

Method Summary

Modifier and Type	Method and Description
void	count(long delta, String metric, MetricLevel metricLevel, String... tags) update Counter.
void	gauge(long value, String metric, MetricLevel metricLevel, String... tags) set init value of Gauge.
Map<String[],Counter>	getAllCounters() Get all counters
Map<String[],Gauge>	getAllGauges() Get all gauges
Map<String[],Histogram>	getAllHistograms() Get all histogram
List<String[]>	getAllMetricKeys() get all metric keys.
Map<String[],Rate>	getAllRates() Get all rates
Map<String[],Timer>	getAllTimers() Get all timers
<T> Gauge	getOrCreateAutoGauge(String metric, MetricLevel metricLevel, T obj, ToLongFunction<T> mapper, String... tags) Get Gauge If exists, then return or create one to return
Counter	getOrCreateCounter(String metric, MetricLevel metricLevel, String... tags) Get Counter If exists, then return or create one to return
Gauge	getOrCreateGauge(String metric, MetricLevel metricLevel, String... tags) Get Gauge If exists, then return or create one to return
Histogram	getOrCreateHistogram(String metric, MetricLevel metricLevel, String... tags) Get Histogram If exists, then return or create one to return
Rate	getOrCreateRate(String metric, MetricLevel metricLevel, String... tags) Get Rate If exists, then return or create one to return
Timer	getOrCreateTimer(String metric, MetricLevel metricLevel, String... tags) Get Timer If exists, then return or create one to return
void	histogram(long value, String metric, MetricLevel metricLevel, String... tags) update Histogram.
boolean	init() init something.
boolean	isEnable() whether is enabled monitor
boolean	isEnable(MetricLevel metricLevel) whether is enabled monitor in specific level
void	rate(long value, String metric, MetricLevel metricLevel, String... tags) update Rate.
void	removeCounter(String metric, String... tags) remove counter
void	removeGauge(String metric, String... tags) remove gauge
void	removeHistogram(String metric, String... tags) remove histogram
void	removeRate(String metric, String... tags) remove rate
void	removeTimer(String metric, String... tags) update timer
boolean	stop() clear metrics
void	timer(long delta, TimeUnit timeUnit, String metric, MetricLevel metricLevel, String... tags) update Timer.

Method Detail

getOrCreateCounter

Counter getOrCreateCounter(String metric,
                           MetricLevel metricLevel,
                           String... tags)

Get Counter If exists, then return or create one to return

Parameters:

tags - string appear in pairs, like sg="ln" will be "sg", "ln"

getOrCreateAutoGauge

<T> Gauge getOrCreateAutoGauge(String metric,
                               MetricLevel metricLevel,
                               T obj,
                               ToLongFunction<T> mapper,
                               String... tags)

Get Gauge If exists, then return or create one to return

This type of gauge will keep a weak reference of the obj, so it will not prevent the obj's gc. NOTICE: When the obj has already been cleared by gc when you call the gauge's value(), then you will get 0L;

Parameters:

obj - which will be monitored automatically

mapper - use which to map the obj to a long value

getOrCreateGauge

Gauge getOrCreateGauge(String metric,
                       MetricLevel metricLevel,
                       String... tags)

Get Gauge If exists, then return or create one to return

Parameters:

tags - string appear in pairs, like sg="ln" will be "sg", "ln"

getOrCreateRate

Rate getOrCreateRate(String metric,
                     MetricLevel metricLevel,
                     String... tags)

Get Rate If exists, then return or create one to return

Parameters:

tags - string appear in pairs, like sg="ln" will be "sg", "ln"

getOrCreateHistogram

Histogram getOrCreateHistogram(String metric,
                               MetricLevel metricLevel,
                               String... tags)

Get Histogram If exists, then return or create one to return

Parameters:

tags - string appear in pairs, like sg="ln" will be "sg", "ln"

getOrCreateTimer

Timer getOrCreateTimer(String metric,
                       MetricLevel metricLevel,
                       String... tags)

Get Timer If exists, then return or create one to return

Parameters:

tags - string appear in pairs, like sg="ln" will be "sg", "ln"

count

void count(long delta,
           String metric,
           MetricLevel metricLevel,
           String... tags)

update Counter. Create if not exists

gauge

void gauge(long value,
           String metric,
           MetricLevel metricLevel,
           String... tags)

set init value of Gauge. Create if not exists

rate

void rate(long value,
          String metric,
          MetricLevel metricLevel,
          String... tags)

update Rate. Create if not exists

histogram

void histogram(long value,
               String metric,
               MetricLevel metricLevel,
               String... tags)

update Histogram. Create if not exists

timer

void timer(long delta,
           TimeUnit timeUnit,
           String metric,
           MetricLevel metricLevel,
           String... tags)

update Timer. Create if not exists

removeCounter

void removeCounter(String metric,
                   String... tags)

remove counter

removeGauge

void removeGauge(String metric,
                 String... tags)

remove gauge

removeRate

void removeRate(String metric,
                String... tags)

remove rate

removeHistogram

void removeHistogram(String metric,
                     String... tags)

remove histogram

removeTimer

void removeTimer(String metric,
                 String... tags)

update timer

getAllMetricKeys

List<String[]> getAllMetricKeys()

get all metric keys.

Returns:

all MetricKeys, key is metric name, value is tags, which is a string array.

getAllCounters

Map<String[],Counter> getAllCounters()

Get all counters

Returns:

[name, tags...] -> counter

getAllGauges

Map<String[],Gauge> getAllGauges()

Get all gauges

Returns:

[name, tags...] -> gauge

getAllRates

Map<String[],Rate> getAllRates()

Get all rates

Returns:

[name, tags...] -> rate

getAllHistograms

Map<String[],Histogram> getAllHistograms()

Get all histogram

Returns:

[name, tags...] -> histogram

getAllTimers

Map<String[],Timer> getAllTimers()

Get all timers

Returns:

[name, tags...] -> timer

isEnable

boolean isEnable()

whether is enabled monitor

isEnable

boolean isEnable(MetricLevel metricLevel)

whether is enabled monitor in specific level

init

boolean init()

init something.

Returns:

whether success

stop

boolean stop()

clear metrics