net.grinder.statistics

Class StatisticsIndexMap

java.lang.Object

net.grinder.statistics.StatisticsIndexMap

All Implemented Interfaces:

Serializable

public final class StatisticsIndexMap
extends Object
implements Serializable

A registry of statistic index objects.

Each statistic has a unique index object and a name. The index objects are used with Statistics and the names can be used in expressions (see ExpressionView). Statistics can either be long integer values (see getLongIndex(java.lang.String)) or double floating-point values (getDoubleIndex(java.lang.String)).

See Statistics for details of the statistics provided by The Grinder.

Sample Statistics

There is a special type of index object for sample statistics, see getLongSampleIndex(java.lang.String) and getDoubleSampleIndex(java.lang.String). Sample statistics are the result of a series of sample values. The values can be either longs or doubles. Sample statistics have three attribute values that can be read: the count (number of samples), sum (total of all sample values), and sample variance. These attributes can be queried using the appropriate expression function (e.g. count()), see ExpressionView.

Author:

Philip Aston

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StatisticsIndexMap.DoubleIndex Class of opaque objects that represent double statistics.
static class	StatisticsIndexMap.DoubleSampleIndex Class of objects that represent sample statistics with double sample values.
static class	StatisticsIndexMap.LongIndex Class of opaque objects that represent long statistics.
static class	StatisticsIndexMap.LongSampleIndex Class of objects that represent sample statistics with long sample values.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HTTP_PLUGIN_CONNECT_TIME_KEY Special slot for the HTTP plugin so it doesn't steal "user" indices.
static String	HTTP_PLUGIN_CONNECTIONS_ESTABLISHED Special slot for the HTTP plugin so it doesn't steal "user" indices.
static String	HTTP_PLUGIN_DNS_TIME_KEY Special slot for the HTTP plugin so it doesn't steal "user" indices.
static String	HTTP_PLUGIN_FIRST_BYTE_TIME_KEY Special slot for the HTTP plugin so it doesn't steal "user" indices.
static String	HTTP_PLUGIN_RESPONSE_ERRORS_KEY Special slot for the HTTP plugin so it doesn't steal "user" indices.
static String	HTTP_PLUGIN_RESPONSE_LENGTH_KEY Special slot for the HTTP plugin so it doesn't steal "user" indicies.
static String	HTTP_PLUGIN_RESPONSE_STATUS_KEY Special slot for the HTTP plugin so it doesn't steal "user" indicies.

Method Summary

Methods

Modifier and Type	Method and Description
StatisticsIndexMap.DoubleIndex	getDoubleIndex(String statisticName) Obtain the index object for the named double statistic.
StatisticsIndexMap.DoubleSampleIndex	getDoubleSampleIndex(String statisticName) Obtain the index object for the named double sample statistic.
StatisticsIndexMap.LongIndex	getLongIndex(String statisticName) Obtain the index object for the named long statistic.
StatisticsIndexMap.LongSampleIndex	getLongSampleIndex(String statisticName) Obtain the index object for the named long statistic.

Methods inherited from class java.lang.Object

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

Field Detail

HTTP_PLUGIN_RESPONSE_STATUS_KEY

public static final String HTTP_PLUGIN_RESPONSE_STATUS_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indicies. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_RESPONSE_LENGTH_KEY

public static final String HTTP_PLUGIN_RESPONSE_LENGTH_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indicies. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_RESPONSE_ERRORS_KEY

public static final String HTTP_PLUGIN_RESPONSE_ERRORS_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indices. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_DNS_TIME_KEY

public static final String HTTP_PLUGIN_DNS_TIME_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indices. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_CONNECT_TIME_KEY

public static final String HTTP_PLUGIN_CONNECT_TIME_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indices. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_FIRST_BYTE_TIME_KEY

public static final String HTTP_PLUGIN_FIRST_BYTE_TIME_KEY

Special slot for the HTTP plugin so it doesn't steal "user" indices. Use with getLongIndex(String).

See Also:

Constant Field Values

HTTP_PLUGIN_CONNECTIONS_ESTABLISHED

public static final String HTTP_PLUGIN_CONNECTIONS_ESTABLISHED

Special slot for the HTTP plugin so it doesn't steal "user" indices. Use with getLongIndex(String).

See Also:

Constant Field Values

Method Detail

getDoubleIndex

public StatisticsIndexMap.DoubleIndex getDoubleIndex(String statisticName)

Obtain the index object for the named double statistic.

Parameters:

statisticName - The statistic name.

Returns:

The index object, or null if there is no such double statistic.

getLongIndex

public StatisticsIndexMap.LongIndex getLongIndex(String statisticName)

Obtain the index object for the named long statistic.

Parameters:

statisticName - The statistic name.

Returns:

The index object, or null if there is no such long statistic.

getDoubleSampleIndex

public StatisticsIndexMap.DoubleSampleIndex getDoubleSampleIndex(String statisticName)

Obtain the index object for the named double sample statistic.

Parameters:

statisticName - The statistic name.

Returns:

The index object, or null if there is no such double sample statistic.

getLongSampleIndex

public StatisticsIndexMap.LongSampleIndex getLongSampleIndex(String statisticName)

Obtain the index object for the named long statistic.

Parameters:

statisticName - The statistic name.

Returns:

The index object, or null if there is no such long sample statistic.