MonitoringDataCollector (monitoring-console-api 1.1 API)

```
public interface MonitoringDataCollector
```
API for collecting monitoring data points from a MonitoringDataSource.

Author:

Jan Bernitt

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`MonitoringDataCollector`	`annotate(CharSequence metric, long value, boolean keyed, String... attrs)` Adds an annotation entry for the given metric with an individual value that can differ from collected value at same point in time in case the collected value represents an aggregate while the annotated value is specific for the annotation instance.
`default MonitoringDataCollector`	`annotate(CharSequence metric, long value, String... attrs)` Same as `annotate(CharSequence, long, boolean, String...)` with `keyed` being `false`.
`default MonitoringDataCollector`	`collect(CharSequence key, boolean value)` Similar to `collect(CharSequence, long)`, true becomes 1L, false zero.
`default MonitoringDataCollector`	`collect(CharSequence key, Boolean value)` Ignores `null`, otherwise collects using `collect(CharSequence, boolean)`.
`default MonitoringDataCollector`	`collect(CharSequence key, char value)` Similar to `collect(CharSequence, long)`, the char simply becomes a number
`default MonitoringDataCollector`	`collect(CharSequence key, double value)` Similar to `collect(CharSequence, long)`.
`default MonitoringDataCollector`	`collect(CharSequence key, Instant value)` Same as calling `collect(CharSequence, long)` with a non null value and `Instant.toEpochMilli()`.
`MonitoringDataCollector`	`collect(CharSequence metric, long value)` Collect a single metric data point (within the current context of tags of this collector).
`default MonitoringDataCollector`	`collect(CharSequence key, Number value)` Ignores `null`, collects `Double` and `Float` using `collect(CharSequence, double)`, others using `collect(CharSequence, long)`.
`default <K,V> MonitoringDataCollector`	`collectAll(Map<K,V> entries, BiConsumer<MonitoringDataCollector,V> collect)`
`default <K,V> MonitoringDataCollector`	`collectAll(Map<K,V> entries, Function<K,CharSequence> entryTag, BiConsumer<MonitoringDataCollector,V> collect)`
`default MonitoringDataCollector`	`collectNonZero(CharSequence key, long value)` Same as `collect(CharSequence, long)` except that zero value are ignored and not collected.
`default <V> MonitoringDataCollector`	`collectObject(V obj, BiConsumer<MonitoringDataCollector,V> collect)` Same as calling `BiConsumer.accept(Object, Object)` with this collector and the passed object.
`default <V> MonitoringDataCollector`	`collectObject(V obj, Class<V> as)`
`default <V> MonitoringDataCollector`	`collectObjects(Collection<V> entries, BiConsumer<MonitoringDataCollector,V> collect)` Collects data points using the passed `BiConsumer` for every entry if the passed `Collection`.
`default MonitoringDataCollector`	`group(CharSequence type)` The type tag states the type of a collected entry.
`default MonitoringDataCollector`	`in(CharSequence namespace)` Namespaces are used to distinguish data points of different origin.
`default MonitoringDataCollector`	`prefix(CharSequence prefix)`
`MonitoringDataCollector`	`tag(CharSequence name, CharSequence value)` Creates a collector with an extended context.

- Method Detail
  - tag
```
MonitoringDataCollector tag(CharSequence name,
                            CharSequence value)
```
    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").
    
    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.
  - collect
```
MonitoringDataCollector collect(CharSequence metric,
                                long value)
```
    Collect a single metric data point (within the current context of tags of this collector).
    
    Parameters:
    
    metric - 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)
  - annotate
```
MonitoringDataCollector annotate(CharSequence metric,
                                 long value,
                                 boolean keyed,
                                 String... attrs)
```
    Adds an annotation entry for the given metric with an individual value that can differ from collected value at same point in time in case the collected value represents an aggregate while the annotated value is specific for the annotation instance. Annotation values do not occur in the time-line of metric data. They exist as meta-data related to the metric series linked by name and time. Annotation should *only* be used for event based data that does not occur all the time as the store only keeps most recent annotations for each series.
    
    Parameters:
    
    metric - name of the metric the annotation relates to
    
    value - value for the annotation instance, usually identical to current collected value but potentially different in case of multiple instances that were aggregated to current collected value.
    
    keyed - true, if the first attribute value given refers to the key used to identify duplicate annotations, else false. Annotations for same key replace each other.
    
    attrs - a sequence of key-value pairs the value is annotated with. For example: ["name", "Foo", "age", "7"]
    
    Returns:
    
    this collector for chaining (with unchanged tags)
  - annotate
```
default MonitoringDataCollector annotate(CharSequence metric,
                                         long value,
                                         String... attrs)
```
    Same as annotate(CharSequence, long, boolean, String...) with keyed being false.
  - prefix
```
default MonitoringDataCollector prefix(CharSequence prefix)
```
  - collectNonZero
```
default MonitoringDataCollector collectNonZero(CharSequence key,
                                               long value)
```
    Same as collect(CharSequence, long) except that zero value are ignored and not collected.
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        double value)
```
    Similar to collect(CharSequence, long). Double values are converted to long by multiplying with 10K effectively offering a precision of 4 fraction digits when converting back to FP number later on.
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        boolean value)
```
    Similar to collect(CharSequence, long), true becomes 1L, false zero.
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        char value)
```
    Similar to collect(CharSequence, long), the char simply becomes a number
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        Number value)
```
    Ignores null, collects Double and Float using collect(CharSequence, double), others using collect(CharSequence, long).
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        Boolean value)
```
    Ignores null, otherwise collects using collect(CharSequence, boolean).
  - collect
```
default MonitoringDataCollector collect(CharSequence key,
                                        Instant value)
```
    Same as calling collect(CharSequence, long) with a non null value and Instant.toEpochMilli().
  - collectObject
```
default <V> MonitoringDataCollector collectObject(V obj,
                                                  BiConsumer<MonitoringDataCollector,V> collect)
```
    Same as calling BiConsumer.accept(Object, Object) with this collector and the passed object.
    
    Returns:
    
    this for chaining, added purely to allow fluent API use
  - collectObjects
```
default <V> MonitoringDataCollector collectObjects(Collection<V> entries,
                                                   BiConsumer<MonitoringDataCollector,V> collect)
```
    Collects data points using the passed BiConsumer for every entry if the passed Collection. The context is not changed
    
    Parameters:
    
    entries - null or empty Collections are ignored
    
    collect - the function collecting the individual data points
    
    Returns:
    
    this for chaining (unchanged context)
  - collectAll
```
default <K,V> MonitoringDataCollector collectAll(Map<K,V> entries,
                                                 BiConsumer<MonitoringDataCollector,V> collect)
```
  - collectAll
```
default <K,V> MonitoringDataCollector collectAll(Map<K,V> entries,
                                                 Function<K,CharSequence> entryTag,
                                                 BiConsumer<MonitoringDataCollector,V> collect)
```
  - collectObject
```
default <V> MonitoringDataCollector collectObject(V obj,
                                                  Class<V> as)
```
  - in
```
default MonitoringDataCollector in(CharSequence namespace)
```
    Namespaces are used to distinguish data points of different origin. Each origin uses its own namespace. The namespace should be the first (top/right most) tag added.
    
    Parameters:
    
    namespace - the namespace to use, e.g. "health-monitor"
    
    Returns:
    
    A collector with the namespace context added/set
  - group
```
default MonitoringDataCollector group(CharSequence type)
```
    The type tag states the type of a collected entry. Most often used for collections of entries of the same kind. The type is usually the second tag added after the namespace.
    
    Parameters:
    
    type - type of entity or collection of entities that are about to be collected
    
    Returns:
    
    A collector with the type context added/set

Interface MonitoringDataCollector

Method Summary

Method Detail

tag

collect

annotate

annotate

prefix

collectNonZero

collect

collect

collect

collect

collect

collect

collectObject

collectObjects

collectAll

collectAll

collectObject

in

group