trait ReporterMetadata extends AnyRef
Access Cinnamon metric metadata in Coda Hale Metrics objects.
- Alphabetic
- By Inheritance
- ReporterMetadata
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
createCache[T](createMetadata: BiFunction[String, Metric, T]): MetadataCache[T]
Create the typed metadata cache.
Create the typed metadata cache. Note: each reporter can have only one metadata cache. Takes function to create metadata from metric name and object, if it's not already cached.
- createMetadata
function to create metadata for a metric object
- returns
new metadata cache specifically for this reporter
-
abstract
def
getDescriptor(metric: Metric): Descriptor
Returns the descriptor for this metric or null if not available.
Returns the descriptor for this metric or null if not available.
- metric
metric object
- returns
descriptor representing the metric object or null if not available
-
abstract
def
getSimpleName(metric: Metric, defaultName: String): String
Get metric simple name, without full hierarchy.
Get metric simple name, without full hierarchy.
- metric
metric object
- defaultName
default name if metadata is not attached
- returns
simple name for metric object, using attached metadata
-
abstract
def
getTags(metric: Metric, includeUnique: Boolean): Map[String, String]
Get metric tags, using attached metadata.
Get metric tags, using attached metadata.
- metric
metric object
- includeUnique
whether to include unique identities as tags
- returns
tags for metric object, using attached metadata
-
abstract
def
getUniqueName(metric: Metric, defaultName: String): String
Get full metric name, including unique dimensions.
Get full metric name, including unique dimensions.
- metric
metric object
- defaultName
default name if metadata is not attached
- returns
unique name for metric object, using attached metadata
-
abstract
def
isAttachedTo(metric: Metric): Boolean
Whether a metric has attached metadata.
Whether a metric has attached metadata.
- metric
metric object that may have attached metadata
- returns
whether metadata is attached to the given metric object
This is the public API for Cinnamon.
The com.lightbend.cinnamon package contains the public Cinnamon API.
See the complete list of Cinnamon packages on the right.
Cinnamon Events and Metrics
For the custom events API see
CinnamonEvents.For the custom metrics API see
CinnamonMetrics.Stopwatch
For the Stopwatch API see
Stopwatch.Coda Hale Metrics
For creating custom Coda Hale Metrics reporters see the com.lightbend.cinnamon.chmetrics.reporter package.