Squidie.Telemetry (squidie v0.3.7)

Copy Markdown View Source

Stable telemetry events and reporter-neutral metric definitions for Squidie.

Squidie emits telemetry but does not install reporters, exporters, dashboards, loggers, or alerting. Hosts remain responsible for those integrations.

Summary

Functions

Returns every public Squidie telemetry event name.

Returns the recommended bounded-cardinality metric definitions.

Returns the recommended metrics with partition included as an explicit opt-in tag.

Returns whether an event name is a public Squidie lifecycle point event.

Returns whether an event prefix is a public Squidie span boundary.

Functions

events()

@spec events() :: [[atom(), ...]]

Returns every public Squidie telemetry event name.

metrics()

@spec metrics() :: [Telemetry.Metrics.t()]

Returns the recommended bounded-cardinality metric definitions.

partition_metrics()

@spec partition_metrics() :: [Telemetry.Metrics.t()]

Returns the recommended metrics with partition included as an explicit opt-in tag.

point_event?(event)

@spec point_event?(term()) :: boolean()

Returns whether an event name is a public Squidie lifecycle point event.

span_prefix?(prefix)

@spec span_prefix?(term()) :: boolean()

Returns whether an event prefix is a public Squidie span boundary.