oracle.adfmf.performance

Class Monitor

Object

oracle.adfmf.performance.StopWatch

oracle.adfmf.performance.Monitor

All Implemented Interfaces:

JSONSerializable

public class Monitor
extends oracle.adfmf.performance.StopWatch
implements JSONSerializable

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

Constructor Summary

Constructors

Constructor and Description
Monitor(MonitorId id, String description) Creates a new monitor.
Monitor(String id, java.util.logging.Level level, String description) Creates a new monitor.

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()
java.util.logging.Level	getLevel()
double	getMean()
long	getObservations()
void	setId(MonitorId id)
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.
Object	toJSON() Method to add custom code to serialize the Object to JSON
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Monitor

public Monitor(String id,
               java.util.logging.Level level,
               String description)

Creates a new monitor.

Parameters:

id - a unique identifier for a monitor

level - logging level

description - a user friendly description of what measurement is captured

Monitor

public Monitor(MonitorId id,
               String description)

Creates a new monitor.

Parameters:

id - a unique identifier for a monitor

description - a user friendly description of what measurement is captured

Method Detail

getId

public MonitorId getId()

Returns:

the unique identifier for this monitor

setId

public void setId(MonitorId id)

getLevel

public 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

public String getDescription()

Returns:

a user friendly description for this Monitor.

addObservation

public void addObservation()

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

addObservation

public 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

public 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

public long getObservations()

getMean

public double getMean()

start

public long start()

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

Overrides:

start in class oracle.adfmf.performance.StopWatch

start

public long start(long startTime)

Starts this Monitor at a specified time.

Overrides:

start in class oracle.adfmf.performance.StopWatch

Parameters:

startTime - an actual start time

stop

public double stop()

Stops the Monitor and optionally records a stop message.

Overrides:

stop in class oracle.adfmf.performance.StopWatch

Returns:

the duration since the last start

toString

public String toString()

Overrides:

toString in class Object

Returns:

a human readable represetnation of this monitor. For example: "Monitor 'com.company.PerformanceTest._NATIVE_TO_EMBEDDED_FEATURE_.Embedded.Serialization.JSON.fromJSON.Class' description: 'invoke fromJSON(Class, Object)' observations: 8 mean: 0.125 standard deviation: 0.3535533905932738"

toJSON

public Object toJSON()
              throws Exception

Description copied from interface: JSONSerializable

Method to add custom code to serialize the Object to JSON

Specified by:

toJSON in interface JSONSerializable

Returns:

Object

Throws:

Exception