Telemetry for Tornex using :telemetry.
Tornex.Telemetry defaults to using Logger to handle telemetry events, but this behavior can be
customized by not attaching the default telemetry handler.
Telemetry Events
Tornex dispatches the following events through :telemetry:
[:tornex, :api, :start]: Executed when there is an API call started against aTornex.Queryor aTornex.SpecQuery.- Measurement:
%{} - Metadata:
%{resource: String.t, resource_id: integer, selections: [String.t()], user: pos_integer}
- Measurement:
[:tornex, :api, :finish]: Executed when the API call started against aTornex.Queryor aTornex.SpecQueryhas finished.- Measurement:
%{latency: pos_integer} - Metadata:
%{resource: String.t, resource_id: integer, selections: [String.t()], user: pos_integer}
- Measurement:
[:tornex, :api, :error]: Executed when an API call has failed.- Measurement:
%{} - Metadata:
%{}
- Measurement:
[:tornex, :api, :timeout]: Executed when an API call is over the timeout value and the API call has been ended.- Measurement:
%{} - Metadata:
%{}
- Measurement:
[:tornex, :bucket, :create]: Executed when a newTornex.Scheduler.Buckethas been created for a user ID.- Measurement:
%{} - Metadata:
%{user_id: pos_integer, pid: pid}
- Measurement:
[:tornex, :bucket, :create_error]: Executed when aTornex.Scheduler.Bucketcould not be created due to some issue.- Measurement:
%{} - Metadata:
%{user_id: pos_integer, error: term}
- Measurement:
[:tornex, :bucket, :timeout]: Dispatched by aTornex.Scheduler.Bucketwhen it has been empty for too long and has been killed.- Measurement:
%{} - Metadata:
%{pid: pid}
- Measurement:
[:tornex, :bucket, :enqueue]: Dispatched by aTornex.Scheduler.Bucketwhen aTornex.SpecQueryhas been run against it or has been enqueued to it.- Measurement:
%{} - Metadata:
%{selections: [String.t], resource: String.t, optional(resource_id): integer, user: pos_integer}
- Measurement:
Summary
Functions
@spec attach_default_logger(opts :: Keyword.t()) :: :ok | {:error, :already_exists}
Attaches the default Tornex :telemetry handler built on-top of Logger.
Options
:ignored- (list) List of events to not be attached:encode- (bool):level- (atom) Minimum log level for telemetry events
@spec detach_default_logger() :: :ok | {:error, :not_found}
Detaches the default Tornex telemetry handler.