View Source Guesswork.Telemetry (Guesswork v0.6.0)
Used to track queries and their metrics.
Summary
Functions
Returns a specification to start this module under a supervisor.
Indicates that a query run has crashed.
Indicates that a query run has crashed.
Pulls all metrics for the requested query_id
.
Increases the number of assignments tracked for a query.
Increases the number of precomputed streams tracked for a query.
Increases the number of substitutions tracked for a query.
Increases the number of test computations tracked for a query.
Pulls all query runs for a specific or all queries from the system.
Pulls all spans for a specific query.
Indicates that a query run has started. If the run has already been started the insert will fail, but quietly.
Indicates that a query span has started. If the span has already been started the insert will fail, but quietly.
Indicates that a query run has stopped.
Indicates that a query span has stopped.
Types
Functions
Returns a specification to start this module under a supervisor.
See Supervisor
.
Indicates that a query run has crashed.
Note that the duration
is assumed to be the native time from a telemetry event.
Indicates that a query run has crashed.
Note that the duration
is assumed to be the native time from a telemetry event.
@spec get_query_metrics(pid() | module(), String.t()) :: Guesswork.Telemetry.QueryMetrics.t()
Pulls all metrics for the requested query_id
.
@spec increment_assignments(pid() | module(), String.t(), non_neg_integer()) :: :ok
Increases the number of assignments tracked for a query.
@spec increment_precomputed_streams(pid() | module(), String.t(), non_neg_integer()) :: :ok
Increases the number of precomputed streams tracked for a query.
@spec increment_substitutions(pid() | module(), String.t(), non_neg_integer()) :: :ok
Increases the number of substitutions tracked for a query.
@spec increment_tests(pid() | module(), String.t(), non_neg_integer()) :: :ok
Increases the number of test computations tracked for a query.
@spec list_query_runs(pid() | module(), String.t() | nil, pagination_opts()) :: Guesswork.Telemetry.PaginatedResponse.t(Guesswork.Telemetry.QueryRun.t())
Pulls all query runs for a specific or all queries from the system.
Available Options:
@spec list_query_spans(pid() | module(), String.t(), pagination_opts()) :: Guesswork.Telemetry.PaginatedResponse.t(Guesswork.Telemetry.QuerySpan.t())
Pulls all spans for a specific query.
Available Options:
Indicates that a query run has started. If the run has already been started the insert will fail, but quietly.
Note that the start_time
is assumed to be the native time from a telemetry
event.
Indicates that a query span has started. If the span has already been started the insert will fail, but quietly.
Note that the start_time
is assumed to be the native time from a telemetry
event.
Indicates that a query run has stopped.
Note that the duration
is assumed to be the native time from a telemetry event.
@spec stop_span( pid() | module(), String.t(), term(), integer(), Guesswork.Telemetry.QuerySpan.metadata() ) :: :ok
Indicates that a query span has stopped.
Note that the duration
is assumed to be the native time from a telemetry event.