fish.payara.monitoring.collect

Interface MonitoringWatchCollector

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MonitoringWatchCollector

API for collecting watches. A watch that is not shared during a collection is stopped. When a watch of same name is shared with different values for thresholds or for conditions any existing watch of the same name but different values is stopped and a new watch with the given values is started. This API is limited an only allows starting watches of a standard type. This limitation is present as for now only such watches are started by sources. Note that watches only have any affect on the DAS instance. This interface exist in its current form to allow a MonitoringDataSource to start watches without making the monitoring implementation dependent on the source module or vice versa. Therefore none of the implementation specific classes is used which causes the watch(CharSequence, String, String) and MonitoringWatchCollector.WatchBuilder methods.

Author:

Jan Bernitt

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	MonitoringWatchCollector.WatchBuilder

Method Summary

Modifier and Type	Method and Description
MonitoringWatchCollector.WatchBuilder	watch(CharSequence series, String name, String unit) Starts creation of a watch with the given name and unit watching the given key metric.

Method Detail

watch

MonitoringWatchCollector.WatchBuilder watch(CharSequence series,
                                            String name,
                                            String unit)

Starts creation of a watch with the given name and unit watching the given key metric. If a watch of the same name already exists the watch continues unless any of the values specified differs in which case the existing watch is stopped and an new one is started.

Parameters:

series - metric key name similar to collect method in MonitoringDataCollector

name - watches installed using this method use the name to identify the watch they refer to.

unit - "count", "percent", "bytes", "sec", "ms" or "ns"

Throws:

IllegalArgumentException - when unit is not one of the recognised unit short names