org.ametys.runtime.plugins.admin.jvmstatus.monitoring

Interface SampleManager

All Known Subinterfaces:

AlertSampleManager

All Known Implementing Classes:

AbstractAlertSampleManager, AbstractMemorySampleManager, AbstractSampleManager, CPUSampleManager, DiskIOSampleManager, DiskSpaceSampleManager, HeapMemorySampleManager, HttpRequestSampleManager, HttpSessionSampleManager, NonHeapMemorySampleManager, SessionSampleManager, ThreadSampleManager, UptimeSampleManager

public interface SampleManager

Interface to be implemented for monitoring samples of data.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	collect(org.rrd4j.core.Sample sample) Collect data into the Round Robin Database.
void	configureRRDDef(org.rrd4j.core.RrdDef rrdDef) Provides the definition to use for this RRD file.
I18nizableText	getDescription() Provides the human readable description.
org.rrd4j.graph.RrdGraphDef	getGraph(String rrdFilePath, int width, int height, MonitoringConstants.Period period) Provides the graph definition to use for rendering a period.
String	getId() Provides the id of this manager. Must be unique in the application.
I18nizableText	getLabel() Provides the human readable name to use.

Method Detail

getId

String getId()

Provides the id of this manager.
Must be unique in the application.

Returns:

the id.

getLabel

I18nizableText getLabel()

Provides the human readable name to use.

Returns:

the human readable name.

getDescription

I18nizableText getDescription()

Provides the human readable description.

Returns:

the human readable description.

configureRRDDef

void configureRRDDef(org.rrd4j.core.RrdDef rrdDef)

Provides the definition to use for this RRD file. Called only when the RRD file is about to be created.

Parameters:

rrdDef - the Round Robin Database definition.

collect

Map<String,Object> collect(org.rrd4j.core.Sample sample)
                    throws IOException

Collect data into the Round Robin Database.

Parameters:

sample - the sample to collect.

Returns:

The collected values for each datasource name.

Throws:

IOException - thrown in case of I/O error.

getGraph

org.rrd4j.graph.RrdGraphDef getGraph(String rrdFilePath,
                                     int width,
                                     int height,
                                     MonitoringConstants.Period period)

Provides the graph definition to use for rendering a period.

Parameters:

rrdFilePath - the path to the RRD file.

width - the width of the image.

height - the height of the image.

period - the period.

Returns:

the graph definition.