fish.payara.monitoring.store

Class SinkDataCollector

java.lang.Object

fish.payara.monitoring.store.SinkDataCollector

All Implemented Interfaces:

MonitoringDataCollector

public class SinkDataCollector
extends Object
implements MonitoringDataCollector

A MonitoringDataCollector that is used as an adapter to MonitoringDataSink abstraction.

Author:

Jan Bernitt

Constructor Summary

Constructors

Constructor and Description
SinkDataCollector(MonitoringDataSink sink)
SinkDataCollector(MonitoringDataSink sink, StringBuilder fullKey)

Method Summary

Modifier and Type	Method and Description
MonitoringDataCollector	collect(CharSequence key, long value) Collect a single metric data point (within the current context of tags of this collector).
MonitoringDataCollector	tag(CharSequence name, CharSequence value) Creates a collector with an extended context.

Methods inherited from class java.lang.Object

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

Methods inherited from interface fish.payara.monitoring.collect.MonitoringDataCollector

app, collect, collect, collect, collect, collect, collect, collectAll, collectNonZero, collectObject, collectObject, collectObjects, entity, in, type

Constructor Detail

SinkDataCollector

public SinkDataCollector(MonitoringDataSink sink)

SinkDataCollector

public SinkDataCollector(MonitoringDataSink sink,
                         StringBuilder fullKey)

Method Detail

collect

public MonitoringDataCollector collect(CharSequence key,
                                       long value)

Description copied from interface: MonitoringDataCollector

Collect a single metric data point (within the current context of tags of this collector).

Specified by:

collect in interface MonitoringDataCollector

Parameters:

key - the plain (context free) name of the metric (e.g. "size")

value - the current value of the metric

Returns:

this collector for chaining (with unchanged tags)

tag

public MonitoringDataCollector tag(CharSequence name,
                                   CharSequence value)

Description copied from interface: MonitoringDataCollector

Creates a collector with an extended context. For example if this collector has the context "foo=bar" and this method is called with name "x" and value "y" the resulting context is "foo=bar x=y". When the context of this collector already contains the tag name the context restarts from that tag regardless if the value is different or identical to the previous one. For example if this collector has the context "foo=bar x=y" and tag is called with name "foo" and value "baz" the new context is "foo=baz" (not "foo=bar x=y foo=baz").

Specified by:

tag in interface MonitoringDataCollector

Parameters:

name - name of the type of context

value - identifier within the context type, if null or empty the tag is ignored

Returns:

A collector that collects data within the context of this collector extended by the given name-value pair.