oracle.dms.instrument
Class PhaseEvent

java.lang.Object
  |
  +--oracle.dms.instrument.Sensor
        |
        +--oracle.dms.instrument.PhaseEvent

public class PhaseEvent

extends Sensor

A PhaseEvent is used to measure important intervals, phases, or blocks of code. Programs call the start() method when the beginning of the interval and the stop() method at the end of the interval. DMS then exports measurements of the duration of the interval, the number of times the event occurred, the minimum and maximum phase duration, and the number of threads currently executing between the start() and stop() markers.

Field Summary

Fields inherited from class oracle.dms.instrument.Sensor

active, all, average, completed, count, exclTime, maxActive, maximum, minimum, sum, time, value

Method Summary

static PhaseEvent	create(Noun parent, java.lang.String name, java.lang.String desc) Creates a new PhaseEvent
void	deriveMetric(int metric) Instructs the PhaseEvent to derive additional metrics.
long	start() Signals the beginning of the Phase.
void	stop(long token) Signals the end of the Phase.

Methods inherited from class oracle.dms.instrument.Sensor

destroy, get, getDescription, getName, getValue, reset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static PhaseEvent create(Noun parent,
                                java.lang.String name,
                                java.lang.String desc)

Creates a new PhaseEvent

Parameters:

parent - the parent Noun

name - the name of the Event

desc - the description of the Event

Returns:

the new PhaseEvent or, if the PhaseEvent already exists, then this method returns a reference to it.

Since:

Oracle iAS 1.0.2.2

deriveMetric

public void deriveMetric(int metric)

Instructs the PhaseEvent to derive additional metrics.

Overrides:

deriveMetric in class Sensor

Parameters:

metric - bitmask of metric(s) to be derived.

Possible values are Sensor.minimum, Sensor.maximum, Sensor.completed, Sensor.average, Sensor.active, Sensor.maxActive and Sensor.all (shorthand for all of the applicable derivations). The values can be bitwise-ORed together, or multiple calls to deriveMetric can be made.

Since:

Oracle iAS 1.0.2.2

start

public long start()

Signals the beginning of the Phase.

Returns:

a token value (timestamp) that must be passed to stop(long)

Since:

Oracle iAS 1.0.2.2

stop

public void stop(long token)

Signals the end of the Phase.

Parameters:

token - the token obtained at the start of the phase

Since:

Oracle iAS 1.0.2.2