fish.payara.monitoring.collect

Annotation Type MonitoringData

@Retention(value=RUNTIME)
 @Target(value=METHOD)
public @interface MonitoringData

Annotation to add meta data to MonitoringDataSource.collect(MonitoringDataCollector) method to customise the collection.

Author:

Jan Bernitt

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	ns This is equivalent to MonitoringDataCollector.in(CharSequence) with the same argument applied to the MonitoringDataCollector before passed to the collected MonitoringDataSource.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	intervalSeconds
boolean	optional This is the initial setting for the annotated MonitoringDataSource that can be changed similar to other server configurations.

Element Detail

ns

public abstract String ns

This is equivalent to MonitoringDataCollector.in(CharSequence) with the same argument applied to the MonitoringDataCollector before passed to the collected MonitoringDataSource. This name-space is also used when controlling the set of enabled/disabled sources via configuration. MonitoringDataSources without an annotation are always collected no matter what name-space they might use in the implementation.

Returns:

The default name-space for the annotated MonitoringDataSource.

intervalSeconds

public abstract int intervalSeconds

Returns:

The time in seconds between data points for the annotated MonitoringDataSource

Default:

1

optional

public abstract boolean optional

This is the initial setting for the annotated MonitoringDataSource that can be changed similar to other server configurations.

Returns:

True in case the annotated MonitoringDataSource should not be collected by default

Default:

false