StatisticsKey (Atlassian Beehive 4.0.2-4fc7269 API)

java.lang.Object
- java.lang.Enum<StatisticsKey>
- - com.atlassian.beehive.core.stats.StatisticsKey

All Implemented Interfaces:

Serializable, Comparable<StatisticsKey>
```
public enum StatisticsKey
extends Enum<StatisticsKey>
```
Represents some type of information that might be collected for a ManagedClusterLock.
Warning: The caller should not make assumptions about which specific statistics are available or what they mean. All statistics are optional; some may be omitted if they have an uninteresting value (like 0); and in many cases the exact meaning has been left open for the implementation to define. The statistics may represent only local information as opposed to reporting the global state of the cluster.

Developers are encouraged to disclose any design decisions they have made in the JavaDocs for the ManagedClusterLock.getStatistics() implementation.

Since:

v0.2

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AVERAGE_HOLD_TIME_MILLIS` The average length of time, in milliseconds, that the lock is held after it has been acquired.
`AVERAGE_WAIT_TIME_MILLIS` The average length of time, in milliseconds, that threads have had to block waiting to acquire the lock, whether they were ultimately successful or not.
`ERROR` The total number of times that a request to acquire/release/renew the lock failed because of a non-state-related exception
`FAIL_LOCAL` The total number of times that a request to acquire the lock failed because it was already held by another thread on the same node.
`FAIL_REMOTE` The total number of times that a request to acquire the lock failed because it was already held by another node in the cluster.
`FORCED_UNLOCK` The total number of times that a lock has had to be "recovered" by forcibly unlocking it.
`LAST_ACCESS` A timestamp, expressed in millis since the epoch, when this lock was last accessed.
`LAST_ERROR` A timestamp, expressed in millis since the epoch, when a last request to acquire/release/renew the lock failed because of a non-state-related exception
`LAST_FAIL_REMOTE` A timestamp, expressed in millis since the epoch, when a request to acquire the lock failed because it was already held by another node in the cluster.
`LAST_LOCK` A timestamp, expressed in millis since the epoch, when this lock was last successfully locked.
`LAST_RENEWAL` A timestamp, expressed in millis since the epoch, when this lock's state was last renewed.
`LAST_STATE_ERROR` A timestamp, expressed in millis since the epoch, when a last request to acquire/release/renew the lock failed because of a lock state state exception
`LAST_UNLOCK` A timestamp, expressed in millis since the epoch, when this lock was last unlocked.
`STATE_ERROR` The total number of times that a request to acquire/release/renew the lock failed because of a lock state related exception
`SUCCESSFUL_LOCKS` The total number of times that the lock has been successfully acquired.
`SUCCESSFUL_UNLOCKS` The total number of times that the lock has been released(regardless of exceptions that happended in the process).
`WAIT_QUEUE_LENGTH` The number of threads that are currently waiting on this lock.

Field Summary

Fields
Modifier and Type Field and Description

static Comparator<StatisticsKey> SORT_BY_LABEL
Sorts statistics keys by label.

Fields
Modifier and Type	Field and Description
`static Comparator<StatisticsKey>`	`SORT_BY_LABEL` Sorts statistics keys by `label`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getLabel()` Returns the label for this statistics key.
`StatisticsType`	`getType()` Returns the type of statistic that this is.
`static StatisticsKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static StatisticsKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - AVERAGE_HOLD_TIME_MILLIS
```
public static final StatisticsKey AVERAGE_HOLD_TIME_MILLIS
```
    The average length of time, in milliseconds, that the lock is held after it has been acquired.
  - AVERAGE_WAIT_TIME_MILLIS
```
public static final StatisticsKey AVERAGE_WAIT_TIME_MILLIS
```
    The average length of time, in milliseconds, that threads have had to block waiting to acquire the lock, whether they were ultimately successful or not.
  - FAIL_LOCAL
```
public static final StatisticsKey FAIL_LOCAL
```
    The total number of times that a request to acquire the lock failed because it was already held by another thread on the same node.
  - FAIL_REMOTE
```
public static final StatisticsKey FAIL_REMOTE
```
    The total number of times that a request to acquire the lock failed because it was already held by another node in the cluster.
  - LAST_FAIL_REMOTE
```
public static final StatisticsKey LAST_FAIL_REMOTE
```
    A timestamp, expressed in millis since the epoch, when a request to acquire the lock failed because it was already held by another node in the cluster.
  - LAST_STATE_ERROR
```
public static final StatisticsKey LAST_STATE_ERROR
```
    A timestamp, expressed in millis since the epoch, when a last request to acquire/release/renew the lock failed because of a lock state state exception
  - STATE_ERROR
```
public static final StatisticsKey STATE_ERROR
```
    The total number of times that a request to acquire/release/renew the lock failed because of a lock state related exception
  - LAST_ERROR
```
public static final StatisticsKey LAST_ERROR
```
    A timestamp, expressed in millis since the epoch, when a last request to acquire/release/renew the lock failed because of a non-state-related exception
  - ERROR
```
public static final StatisticsKey ERROR
```
    The total number of times that a request to acquire/release/renew the lock failed because of a non-state-related exception
  - LAST_ACCESS
```
public static final StatisticsKey LAST_ACCESS
```
    A timestamp, expressed in millis since the epoch, when this lock was last accessed.
  - LAST_LOCK
```
public static final StatisticsKey LAST_LOCK
```
    A timestamp, expressed in millis since the epoch, when this lock was last successfully locked.
  - LAST_UNLOCK
```
public static final StatisticsKey LAST_UNLOCK
```
    A timestamp, expressed in millis since the epoch, when this lock was last unlocked.
  - LAST_RENEWAL
```
public static final StatisticsKey LAST_RENEWAL
```
    A timestamp, expressed in millis since the epoch, when this lock's state was last renewed.
  - FORCED_UNLOCK
```
public static final StatisticsKey FORCED_UNLOCK
```
    The total number of times that a lock has had to be "recovered" by forcibly unlocking it.
  - SUCCESSFUL_LOCKS
```
public static final StatisticsKey SUCCESSFUL_LOCKS
```
    The total number of times that the lock has been successfully acquired.
  - SUCCESSFUL_UNLOCKS
```
public static final StatisticsKey SUCCESSFUL_UNLOCKS
```
    The total number of times that the lock has been released(regardless of exceptions that happended in the process).
  - WAIT_QUEUE_LENGTH
```
public static final StatisticsKey WAIT_QUEUE_LENGTH
```
    The number of threads that are currently waiting on this lock.
- Field Detail
  - SORT_BY_LABEL
```
public static Comparator<StatisticsKey> SORT_BY_LABEL
```
    Sorts statistics keys by label.
- Method Detail
  - values
```
public static StatisticsKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (StatisticsKey c : StatisticsKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static StatisticsKey valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getLabel
```
public String getLabel()
```
    Returns the label for this statistics key. This is intended to be the same as the Enum.name(), except written in camelCase.
    
    Returns:
    
    the label for this statistics key.
  - getType
```
public StatisticsType getType()
```
    Returns the type of statistic that this is.
    
    Returns:
    
    the type of statistic that this is.

Enum StatisticsKey

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

AVERAGE_HOLD_TIME_MILLIS

AVERAGE_WAIT_TIME_MILLIS

FAIL_LOCAL

FAIL_REMOTE

LAST_FAIL_REMOTE

LAST_STATE_ERROR

STATE_ERROR

LAST_ERROR

ERROR

LAST_ACCESS

LAST_LOCK

LAST_UNLOCK

LAST_RENEWAL

FORCED_UNLOCK

SUCCESSFUL_LOCKS

SUCCESSFUL_UNLOCKS

WAIT_QUEUE_LENGTH

Field Detail

SORT_BY_LABEL

Method Detail

values

valueOf

getLabel

getType