public interface MetricKey
| Modifier and Type | Field and Description |
|---|---|
static Comparator<MetricKey> |
NAME_COMPARATOR
Comparator to sort keys by their names.
|
| Modifier and Type | Method and Description |
|---|---|
MetricKey |
doc(String string)
Sets the documentation for this key.
|
String |
getDoc()
Gets the documentation for this key.
|
String |
getDocName()
Gets the name to use when listing keys.
|
String |
getName()
Gets the name of this key.
|
org.graalvm.collections.Pair<String,String> |
toCSVFormat(long value)
Converts a given value for this key to a CSV format intended for automated data processing.
|
String |
toHumanReadableFormat(long value)
Converts a given value for this key to a string, scaling it to a more useful unit of
measurement and appending a suffix indicating the unit where applicable.
|
static final Comparator<MetricKey> NAME_COMPARATOR
String toHumanReadableFormat(long value)
org.graalvm.collections.Pair<String,String> toCSVFormat(long value)
value - value with any scaling conversion applied and
second is the unit of measurement used for the first component (this will be the
empty string for a simple counter)String getName()
String getDocName()
MetricKey.getName().null if this key is derived from another key and so should not be listedString getDoc()
null if this key has no documentation