Sovite.Metrics.Metric (sovite v0.6.0)

Copy Markdown View Source

A metric definition, built by Sovite.Metrics.counter/2, Sovite.Metrics.sum/2, Sovite.Metrics.last_value/2 or Sovite.Metrics.distribution/2. See Sovite.Metrics for the options.

Summary

Types

t()
type()

The kind of metric.

Types

t()

@type t() :: %Sovite.Metrics.Metric{
  buckets: [number()] | nil,
  event: :telemetry.event_name(),
  help: String.t() | nil,
  keep: (map() -> boolean()) | nil,
  max_series: pos_integer(),
  measurement: atom() | (map(), map() -> number() | nil) | nil,
  name: String.t(),
  tag_values: (map() -> map()) | nil,
  tags: [atom()],
  type: type(),
  unit: {:native, :second | :millisecond | :microsecond} | nil
}

type()

@type type() :: :counter | :sum | :last_value | :distribution

The kind of metric.