Skip navigation links

oracle.dms.instrument
Class Noun

java.lang.Object
oracle.dms.instrument.Noun

public class Noun

extends java.lang.Object

Noun objects are used to organize the DMS name hierarchy. Nouns may contain Sensors or other Nouns. Generally, Nouns correspond program objects that are to be measured. By convention, Noun names start with a capital letter to distinguish them from Sensors. Character '/' is the default delimiter between Noun names. It is not recommanded that '/' is used as a part of the Noun name.

A Noun type is a name that reflects the set of metrics being collected. By convention, Noun type names are prefixed with the component name followed by an underscore. It is recommended that Nouns of the same type should have the same set of the metrics.

Field Summary

static byte	ALL Tells the rollup feature to extract data from all descending Nouns.
static byte	DIRECT Tells the rollup feature to extract data from child Nouns only.
static java.lang.String	UNKNOWN_TYPE The default Noun type.

Method Summary

static Noun	create(Noun parent, java.lang.String name, java.lang.String type) Creates a new Noun given a Noun parent, and a basename for the new Noun (not a pathname)
static Noun	create(java.lang.String pathname, java.lang.String type) Creates a new Noun given a pathname.
void	destroy() Destroys the Noun and all of its descendants.
static Noun	get(java.lang.String pathname) Returns a Noun given the Noun's pathname
static Noun	getRoot() Returns the root Noun for this JVM
java.lang.String	getType() Returns the type of a Noun as a String.
Noun	rollup(java.lang.String type, byte descendents) Rolls up Sensor metrics from descendent Nouns of the specified type.

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN_TYPE

public static final java.lang.String UNKNOWN_TYPE

The default Noun type. DMS does not export Nouns and their child metrics of this Noun type. Nouns with UNKNOWN_TYPE can be useful for organizing Nouns.

Since:

Oracle iAS 9.0.2

See Also:

Constant Field Values

DIRECT

public static final byte DIRECT

Tells the rollup feature to extract data from child Nouns only.

See Also:

Constant Field Values

ALL

public static final byte ALL

Tells the rollup feature to extract data from all descending Nouns.

See Also:

Constant Field Values

Method Detail

create

public static Noun create(java.lang.String pathname,
                          java.lang.String type)

Creates a new Noun given a pathname.

Parameters:

pathname - the pathname of the Noun

type - name of type for the Noun

Returns:

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

Since:

Oracle iAS 1.0.2.2

create

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

Creates a new Noun given a Noun parent, and a basename for the new Noun (not a pathname)

Parameters:

parent - the Noun's parent

name - the Noun's short basename (not a pathname).

type - the Noun's type

Returns:

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

Since:

Oracle iAS 1.0.2.2

getType

public java.lang.String getType()

Returns the type of a Noun as a String.

Returns:

the type of a Noun as a String. Returns UNKNOWN_TYPE if the type was not explicitly set.

Since:

Oracle iAS 9.0.2

get

public static Noun get(java.lang.String pathname)

Returns a Noun given the Noun's pathname

Parameters:

pathname - the pathname of the in the form <delim>name<delim>name... examples: /Wisconsin/Green/Monroe.Oregon.Multnomah.Portland etc.

Returns:

the Noun specified by pathname, or null if the Noun cannot be found.

Since:

Oracle iAS 1.0.2.2

getRoot

public static Noun getRoot()

Returns the root Noun for this JVM

Returns:

the root Noun for this JVM

Since:

Oracle iAS 1.0.2.2

rollup

public Noun rollup(java.lang.String type,
                   byte descendents)

Rolls up Sensor metrics from descendent Nouns of the specified type.

This method causes a new DMS Noun, the rollup Noun, to be created directly under the calling Noun. Its name is type+"_rollup", and it's type is the same. Two DMS States are created under the rollup Noun:

• descendents - contains either DIRECT or ALL depending on whether only Nouns of the specified type directly under the calling Noun will be rolled up, or whether all descendent Nouns of the specified type will be rolled up.
• count - this contains an integer that will indicate the number of Nouns that are rolled up under the rollup Noun. It will be updated each time the metrics are rolled up.

The first time metrics are accessed under the rollup Noun, appropriate metrics will be generated which summarize the metrics under the Nouns of the specified type. For the sake of discussion, suppose our Nouns contain the following three sensors:

• PhaseEvent myPhase;
• Event myEvent;
• State myState;

Assume that each Sensor is named as above, so PhaseEvent myPhase is named "myPhase". For every metric in each of the Sensors, one or more metrics will be generated in the rollup Noun as follows:

PhaseEvent:

• myPhase.time - the sum of time metrics.
• myPhase.completed - the sum of the completed metrics.
• myPhase.maxTime - the maximum of the maxTime metrics.
• myPhase.minTime - the minimum of the minTime metrics.
• myPhase.avg - the average time computed for all myPhase Sensors.
• myPhase.active contains the sum of the active metrics.

Note that the maxActive metric is not summarized, as the semantics of such a summary would be unclear.

Event:

• myEvent.sum - the total of all count metrics.
• myEvent.avg - the average of all count metrics.

State:

• myState.sum - the total of all value metrics.
• myState.avg - the average of all value metrics.
• myState.maxValue - the maximum of the maxValue metrics.
• myState.minValue - the minimum of the minValue metrics.

Note that the rollup feature will only be applied to DMS States which contain numerical values.

Every time the metrics in the rollup Noun are requested, the above listed metrics will be recomputed.

Parameters:

type - the type of Noun from which metrics will be extracted.

descendents - extract metrics from child Nouns or all descendents.

Returns:

rollup Noun or null if it could not be created.

Since:

Oracle AS 1.0.3

destroy

public void destroy()

Destroys the Noun and all of its descendants.

Since:

Oracle iAS 1.0.2.2

Skip navigation links