Packages

trait ReporterMetadata extends AnyRef

Access Cinnamon metric metadata in Coda Hale Metrics objects.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReporterMetadata
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. 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

  2. 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

  3. 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

  4. 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

  5. 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

  6. 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