SnakeBridge.Telemetry.Handlers.Metrics (SnakeBridge v0.16.0)

Copy Markdown View Source

Metric definitions for SnakeBridge telemetry.

This module provides metric definitions compatible with TelemetryMetrics and reporters like TelemetryMetricsPrometheus.

Usage

# In your application with TelemetryMetricsPrometheus
TelemetryMetricsPrometheus.Core.attach(
  SnakeBridge.Telemetry.Handlers.Metrics.metrics()
)

Metrics

Compilation

  • snakebridge.compile.duration - Distribution of compilation times
  • snakebridge.compile.symbols_generated - Sum of symbols generated
  • snakebridge.compile.total - Counter of compilations

Scanning

  • snakebridge.scan.duration - Distribution of scan times
  • snakebridge.scan.files_scanned - Sum of files scanned
  • snakebridge.scan.symbols_found - Sum of symbols found

Introspection

  • snakebridge.introspect.duration - Distribution of introspection times
  • snakebridge.introspect.symbols_introspected - Sum of symbols introspected
  • snakebridge.introspect.cache_hits - Sum of cache hits

Generation

  • snakebridge.generate.duration - Distribution of generation times
  • snakebridge.generate.bytes_written - Sum of bytes written

Documentation

  • snakebridge.docs.fetch.duration - Distribution of doc fetch times
  • snakebridge.docs.fetch.total - Counter of doc fetches

Summary

Functions

Returns a list of Telemetry.Metrics definitions.

Functions

metrics()

@spec metrics() :: [struct()]

Returns a list of Telemetry.Metrics definitions.

These can be used with any TelemetryMetrics-compatible reporter.