Spandex v2.4.0 Spandex.Tracer behaviour View Source
A module that can be used to build your own tracer.
Example:
defmodule MyApp.Tracer do
use Spandex.Tracer, otp_app: :my_app
end
Link to this section Summary
Functions
A schema for the opts that a tracer accepts
Link to this section Types
Link to this section Functions
A schema for the opts that a tracer accepts.
Opts
adapter
(:atom
) Required: The third party adapter to usedisabled?
(:boolean
): Allows for wholesale disabling a tracer - Default: falsestrategy
(:atom
): The storage and tracing strategy. Currently only supports local process dictionary. - Default: Spandex.Strategy.Pdictsender
(:atom
): Once a trace is complete, it is sent using this module. Defaults to thedefault_sender/0
of the selected adaptertrace_key
(:atom
): Don’t set manually. This option is passed automatically.
Span Creation
service
(:atom
) Required: The default service name to use for spans declared without a serviceenv
(:string
): A name used to identify the environment name, e.gprod
ordevelopment
services
([{:keyword, :atom}, :keyword]
): A mapping of service name to the default span types. - Default: []completion_time
(:integer
)error
(:keyword
)http
(:keyword
)id
(:any
)name
(:string
)parent_id
(:any
)private
(:keyword
) - Default: []resource
([:atom, :string]
)sql_query
(:keyword
)start
(:integer
)tags
(:keyword
) - Default: []trace_id
(:any
)type
(:atom
)
All tracer functions that take opts use this schema. This also accepts defaults for any value that can be given to a span.
Link to this section Callbacks
Link to this callback
continue_trace(span_name, trace_context, opts)
View Source
continue_trace( span_name :: String.t(), trace_context :: Spandex.SpanContext.t(), opts() ) :: tagged_tuple(Spandex.Trace.t())
Link to this callback
continue_trace_from_span(span_name, span, opts)
View Source
continue_trace_from_span(span_name(), span :: term(), opts()) :: tagged_tuple(Spandex.Trace.t())
Link to this callback
current_context(opts)
View Source
current_context(opts()) :: {:ok, Spandex.SpanContext.t()} | {:error, :disabled} | {:error, :no_span_context} | {:error, :no_trace_context} | {:error, [Optimal.error()]}
Link to this callback
current_span_id(opts)
View Source
current_span_id(opts()) :: nil | Spandex.id()
Link to this callback
current_trace_id(opts)
View Source
current_trace_id(opts()) :: nil | Spandex.id()
Link to this callback
distributed_context(arg0, opts)
View Source
distributed_context(Plug.Conn.t(), opts()) :: tagged_tuple(map())
Link to this callback
finish_span(opts)
View Source
finish_span(opts()) :: tagged_tuple(Spandex.Span.t())
Link to this callback
finish_trace(opts)
View Source
finish_trace(opts()) :: tagged_tuple(Spandex.Trace.t())
Link to this callback
inject_context(arg0, opts)
View Source
inject_context(Spandex.headers(), opts()) :: Spandex.headers()
Link to this callback
span_error(error, stacktrace, opts)
View Source
span_error(error :: Exception.t(), stacktrace :: [term()], opts()) :: tagged_tuple(Spandex.Span.t())
Link to this callback
start_span(span_name, opts)
View Source
start_span(span_name(), opts()) :: tagged_tuple(Spandex.Span.t())
Link to this callback
start_trace(span_name, opts)
View Source
start_trace(span_name(), opts()) :: tagged_tuple(Spandex.Trace.t())
Link to this callback
update_span(opts)
View Source
update_span(opts()) :: tagged_tuple(Spandex.Span.t())
Link to this callback
update_top_span(opts)
View Source
update_top_span(opts()) :: tagged_tuple(Spandex.Span.t())