org.graalvm.compiler.debug

Interface MetricKey

All Known Subinterfaces:

CounterKey, MemUseTrackerKey, TimerKey

public interface MetricKey

A key for a metric.

Field Summary

Fields

Modifier and Type	Field and Description
static Comparator<MetricKey>	NAME_COMPARATOR Comparator to sort keys by their names.

Method Summary

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.

Field Detail

NAME_COMPARATOR

static final Comparator<MetricKey> NAME_COMPARATOR

Comparator to sort keys by their names.

Method Detail

toHumanReadableFormat

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. This representation is intended for human consumption.

toCSVFormat

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.

Parameters:

value -

Returns:

a pair where first is the 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)

getName

String getName()

Gets the name of this key.

doc

MetricKey doc(String string)

Sets the documentation for this key.

getDocName

String getDocName()

Gets the name to use when listing keys. Note that this may be different from MetricKey.getName().

Returns:

null if this key is derived from another key and so should not be listed

getDoc

String getDoc()

Gets the documentation for this key.

Returns:

null if this key has no documentation