ScoutApm.MetricSet (scout_apm v2.0.0)

Copy Markdown

A way to absorb & combine metrics into a single set, keeping track of min/max/count, etc.

While this is just a map underneath, treat it like an opaque data type.

Summary

Types

options()
t()

Functions

absorb(metric_set, metric)

Add this metric to this metric set.

absorb_all(metric_set, metrics)
merge(set1, set2)
new()
new(options)
to_list(metric_set)

Types

options()

@type options() :: %{
  collapse_all: boolean(),
  compare_desc: boolean(),
  max_types: non_neg_integer()
}

t()

@type t() :: %ScoutApm.MetricSet{data: map(), options: options(), types: MapSet.t()}

Functions

absorb(metric_set, metric)

@spec absorb(t(), ScoutApm.Internal.Metric.t()) :: t()

Add this metric to this metric set.

As a safety valve in the agent, this skips adding if we've reached the limit of unique 'type' values in this set. Since 'type' is something like 'Ecto' or 'Controller', it's very unlikely that this safety valve ever gets hit in normal practice, but instead is designed to protect people from accidentally varying their custom instrumentation types.

absorb_all(metric_set, metrics)

@spec absorb_all(t(), [ScoutApm.Internal.Metric.t()]) :: t()

merge(set1, set2)

@spec merge(t(), t()) :: t()

new()

@spec new() :: t()

new(options)

@spec new(map()) :: t()

to_list(metric_set)

@spec to_list(t()) :: [ScoutApm.Internal.Metric.t()]