oracle.adfmf.performance

Interface Monitor

public interface Monitor

A simple performance sensor that can be started and stopped and can collect observations.

Method Summary

Modifier and Type	Method and Description
void	addObservation() Records the observation and stops the monitor.
void	addObservation(double duration) Records the obervation but does not stop the monitor.
void	addObservation(long stopTime, double duration) Records observation observed at a specified time.
String	getDescription()
MonitorId	getId()
String	getInstanceData()
java.util.logging.Level	getLevel()
double	getMean()
long	getObservations()
long	start() Starts the Monitor at the current time and optionally records a start message.
long	start(long startTime) Starts this Monitor at a specified time.
double	stop() Stops the Monitor and optionally records a stop message.

Method Detail

getId

MonitorId getId()

Returns:

the unique identifier for this monitor

getLevel

java.util.logging.Level getLevel()

Returns:

the logging level for this monitor. If "oracle.maf.performance.monitor.observations.reported" logger is loggable at this level, Monitor start/stop methods will be logged. If "oracle.maf.performance.monitor.reported" logger is loggable at this level, Monitor will be dumped during dumpStatistics.

getDescription

String getDescription()

Returns:

a user friendly description for this Monitor.

getInstanceData

String getInstanceData()

Returns:

the instance data for this specific monitor instance.

addObservation

void addObservation()

Records the observation and stops the monitor. This flavor of addObservation should be used for Monitors measuring duration.

addObservation

void addObservation(double duration)

Records the obervation but does not stop the monitor. This flavor of addObservation should be used for count type Monitors.

Parameters:

duration - time since the last observation

addObservation

void addObservation(long stopTime,
                    double duration)

Records observation observed at a specified time. This flavor of addObservation should be used for Monitors that measure duration but have been stopped at some previous time.

Parameters:

stopTime - time at which observation was recorded

duration - duration since the last observation

getObservations

long getObservations()

Returns:

the number of reported observations.

getMean

double getMean()

start

long start()

Starts the Monitor at the current time and optionally records a start message.

start

long start(long startTime)

Starts this Monitor at a specified time.

Parameters:

startTime - an actual start time

stop

double stop()

Stops the Monitor and optionally records a stop message.

Returns:

the duration since the last start