de.uni_hildesheim.sse.monitoring.runtime.annotations

Annotation Type Monitor

@Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD,CONSTRUCTOR,PACKAGE})
public @interface Monitor

The central annotation. Mark a class, method or constructor with this annotation in order to monitor and aggregate values to it.

Since:

1.00

Version:

1.20

Author:

Holger Eichelberger

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
BooleanValue	considerContained Returns whether accountable resources of the multi monitoring group is authoritative (false) or weather the contained groups should be considered (true).
DebugState[]	debug Define any combination of debug states for additional information to be emitted during monitoring.
BooleanValue	distributeValues Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.
GroupAccountingType	groupAccounting Define the group accounting to be applied.
java.lang.String[]	id Contains arbitrary ids for monitoring and grouping.
InstanceIdentifierKind	instanceIdentifierKind Returns the instance identifier to be used for more detailed monitoring.
ResourceType[]	resources Defines the resources to be accounted.

Element Detail

id

public abstract java.lang.String[] id

Contains arbitrary ids for monitoring and grouping. If none is given, the class name is used. If given, classes with same id are recorded as one group. If multiple are given, resources are accounted to the multiple groups. If given in form name1@name2 name1 is interpreted as identifier of a variability, name2 as name of a variant implementing the variability.

Returns:

the ids, use the class name if empty

Since:

1.00

Default:

""

debug

public abstract DebugState[] debug

Define any combination of debug states for additional information to be emitted during monitoring.

Returns:

the debug states, empty by default

Since:

1.00

Default:

{}

groupAccounting

public abstract GroupAccountingType groupAccounting

Define the group accounting to be applied. By default this value is set to GroupAccountingType.DEFAULT and, therefore, taken from the global configuration.

Returns:

the group accounting type, the default type by default

Since:

1.00

Default:

de.uni_hildesheim.sse.monitoring.runtime.boot.GroupAccountingType.DEFAULT

resources

public abstract ResourceType[] resources

Defines the resources to be accounted. By default, all resources defined as default in the configuration shall be accounted.

Returns:

the specific resources to be accounted, by default all (empty)

Since:

1.00

Default:

{}

distributeValues

public abstract BooleanValue distributeValues

Returns whether values in multi groups should be distributed evenly to the contained values or whether the entire value should be added to each group.

Returns:

whether values should be distributed

Since:

1.00

Default:

de.uni_hildesheim.sse.monitoring.runtime.boot.BooleanValue.DEFAULT

considerContained

public abstract BooleanValue considerContained

Returns whether accountable resources of the multi monitoring group is authoritative (false) or weather the contained groups should be considered (true).

Returns:

whether contained groups shall be considered

Since:

1.00

Default:

de.uni_hildesheim.sse.monitoring.runtime.boot.BooleanValue.DEFAULT

instanceIdentifierKind

public abstract InstanceIdentifierKind instanceIdentifierKind

Returns the instance identifier to be used for more detailed monitoring.

Returns:

which identifier kind shall be used, none by default

Since:

1.20

Default:

de.uni_hildesheim.sse.monitoring.runtime.boot.InstanceIdentifierKind.NONE