perffmwk

Class PerformanceStatistics

java.lang.Object

perffmwk.PerformanceStatistics

Direct Known Subclasses:

CachePerfStats, CacheSizeStats, ClockSkewStats, DLSPerfStats, HistogramStats, PerfStats, PutAllPerfStats, QueryPerfStats, SampleThreadStatistics, SampleVMStatistics, UseCase3Stats

public class PerformanceStatistics
extends Object

An instance of a performance statistics type. It uses the process id of the process that creates it as its numeric display name, and registers itself with the hydra master for reporting purposes.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.gemstone.gemfire.Statistics	statistics The statistics instance.
static int	THREAD_SCOPE Used to specify that an instance will be used by a single thread.
static int	VM_SCOPE Used to specify that an instance will be used by all threads in a VM.

Constructor Summary

Constructors

Constructor and Description
PerformanceStatistics(Class cls, com.gemstone.gemfire.StatisticsType type, int scope, String instanceName, String trimspecName) Creates an instance with the specified type, scope, name, and trim specification name.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the statistics instance.
static com.gemstone.gemfire.StatisticsFactory	factory() Returns the factory used to create statistics descriptors and types.
static PerformanceStatistics	getInstance(Class cls, int scope) Gets the statistics instance with the specified class, an autogenerated display name based on the specified scope, associated with the default trim specification.
static PerformanceStatistics	getInstance(Class cls, int scope, String name) Gets the statistics instance with the specified class and an autogenerated display name based on the specified name and scope, associated with the default trim specification.
static PerformanceStatistics	getInstance(Class cls, int scope, String name, String trimspecName) Gets the statistics instance with the specified class and an autogenerated display name based on the specified scope and name, associated with the specified trim specification name.
String	getName() Returns the name of this instance.
com.gemstone.gemfire.StatisticDescriptor	getStatisticDescriptor(String statName) Returns the statistic descriptor for the statistic with the given name for this instance.
String	getTrimSpecName() Returns the logical name of the trim specification for these statistics.
com.gemstone.gemfire.Statistics	statistics() Returns the statistics instance.

Methods inherited from class java.lang.Object

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

Field Detail

THREAD_SCOPE

public static final int THREAD_SCOPE

Used to specify that an instance will be used by a single thread.

See Also:

Constant Field Values

VM_SCOPE

public static final int VM_SCOPE

Used to specify that an instance will be used by all threads in a VM.

See Also:

Constant Field Values

statistics

protected com.gemstone.gemfire.Statistics statistics

The statistics instance.

Constructor Detail

PerformanceStatistics

public PerformanceStatistics(Class cls,
                             com.gemstone.gemfire.StatisticsType type,
                             int scope,
                             String instanceName,
                             String trimspecName)

Creates an instance with the specified type, scope, name, and trim specification name. The display name is generated based on the scope and name. For per-thread scope, it is the name (defaults to "Thread") plus the logical hydra thread ID. For per-VM scope, it is the name (defaults to "VM"). Valid values for scope are THREAD_SCOPE and VM_SCOPE. The named trim specification is associated with the instance for reporting purposes (defaults to TrimSpec.DEFAULT_TRIM_SPEC_NAME).

Method Detail

factory

public static com.gemstone.gemfire.StatisticsFactory factory()

Returns the factory used to create statistics descriptors and types.

getInstance

public static PerformanceStatistics getInstance(Class cls,
                                                int scope)

Gets the statistics instance with the specified class, an autogenerated display name based on the specified scope, associated with the default trim specification. Lazily creates the instance.

getInstance

public static PerformanceStatistics getInstance(Class cls,
                                                int scope,
                                                String name)

Gets the statistics instance with the specified class and an autogenerated display name based on the specified name and scope, associated with the default trim specification. Lazily creates the instance.

getInstance

public static PerformanceStatistics getInstance(Class cls,
                                                int scope,
                                                String name,
                                                String trimspecName)

Gets the statistics instance with the specified class and an autogenerated display name based on the specified scope and name, associated with the specified trim specification name. Lazily creates the type and instance.

close

public void close()

Closes the statistics instance.

getName

public String getName()

Returns the name of this instance.

statistics

public com.gemstone.gemfire.Statistics statistics()

Returns the statistics instance.

getStatisticDescriptor

public com.gemstone.gemfire.StatisticDescriptor getStatisticDescriptor(String statName)

Returns the statistic descriptor for the statistic with the given name for this instance.

Throws:

PerfStatException - if the instance has no stat name is not found.

getTrimSpecName

public String getTrimSpecName()

Returns the logical name of the trim specification for these statistics.