Specs

continue_trace(String.t(), Spandex.SpanContext.t(), Keyword.t()) ::
  {:ok, Spandex.Trace.t()}
  | {:error, :disabled}
  | {:error, :trace_already_present}

Given a %SpanContext{}, resumes a trace from a different process or service.

Span updates for the top span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a second call to update_span/2 and check the return value.

Specs

continue_trace(String.t(), id(), id(), Keyword.t()) ::
  {:ok, Spandex.Trace.t()}
  | {:error, :disabled}
  | {:error, :trace_already_present}

Given a trace_id and span_id, resumes a trace from a different process or service.

Span updates for the top span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a second call to update_span/2 and check the return value.

Specs

continue_trace_from_span(String.t(), Spandex.Span.t(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.Trace.t()}
  | {:error, :disabled}
  | {:error, :trace_already_present}

Given a span struct, resumes a trace from a different process or service.

Span updates for the top span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a second call to update_span/2 and check the return value.

Specs

current_context(Spandex.Tracer.opts()) ::
  {:ok, Spandex.SpanContext.t()}
  | {:error, :disabled}
  | {:error, :no_span_context}
  | {:error, :no_trace_context}

Returns the current %SpanContext{} or an error.

DEPRECATION WARNING

Expect changes to this in the future, as this will eventualy be refactored to only ever return a %SpanContext{}, or at least to always return something consistent.

Specs

current_span(Spandex.Tracer.opts()) :: Spandex.Span.t() | nil

Returns the %Span{} struct for the currently-running span

Specs

current_span_id(Spandex.Tracer.opts()) :: id() | nil

Returns the id of the currently-running span.

Specs

current_trace_id(Spandex.Tracer.opts()) :: id() | nil

Returns the id of the currently-running trace.

Specs

distributed_context(Plug.Conn.t(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.SpanContext.t()} | {:error, :disabled}

distributed_context(headers(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.SpanContext.t()} | {:error, :disabled}

Returns the context from a given set of HTTP headers, as determined by the adapter.

Specs

finish_span(Spandex.Tracer.opts()) ::
  {:ok, Spandex.Span.t()}
  | {:error, :disabled}
  | {:error, :no_trace_context}
  | {:error, :no_span_context}

Finishes the current span.

Span updates for that span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a call to update_span/2 and check the return value before finishing the span.

Specs

finish_trace(Spandex.Tracer.opts()) ::
  {:ok, Spandex.Trace.t()} | {:error, :disabled} | {:error, :no_trace_context}

Finishes the current trace.

Span updates for the top span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a call to update_span/2 and check the return value before finishing the trace.

Specs

inject_context(headers(), Spandex.SpanContext.t(), Spandex.Tracer.opts()) ::
  headers()

Alters headers to include the outgoing HTTP headers necessary to continue a distributed trace, as determined by the adapter.

Specs

span_error(Exception.t(), Enum.t(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.Span.t()}
  | {:error, :disabled}
  | {:error, :no_trace_context}
  | {:error, :no_span_context}
  | {:error, [Optimal.error()]}

Updates the current span with error details.

In the case of an invalid value, validation errors are returned.

Specs

start_span(String.t(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.Span.t()} | {:error, :disabled} | {:error, :no_trace_context}

Start a new span.

Span updates for that span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a second call to update_span/2 and check the return value.

Specs

start_trace(binary(), Spandex.Tracer.opts()) ::
  {:ok, Spandex.Trace.t()}
  | {:error, :disabled}
  | {:error, :trace_running}
  | {:error, [Optimal.error()]}

Starts a new trace.

Span updates for the first span may be passed in. They are skipped if they are invalid updates. As such, if you aren't sure if your updates are valid, it is safer to perform a second call to update_span/2 and check the return value.

Specs

update_all_spans(Spandex.Tracer.opts()) ::
  {:ok, Spandex.Trace.t()}
  | {:error, :disabled}
  | {:error, :no_trace_context}
  | {:error, [Optimal.error()]}

Updates all spans, whether complete or in-progress.

In the case of an invalid update for any span, validation errors are returned.

Specs

update_span(Spandex.Tracer.opts(), boolean()) ::
  {:ok, Spandex.Span.t()}
  | {:error, :disabled}
  | {:error, :no_trace_context}
  | {:error, :no_span_context}
  | {:error, [Optimal.error()]}

Updates the current span.

In the case of an invalid update, validation errors are returned.

Specs

update_top_span(Spandex.Tracer.opts()) ::
  {:ok, Spandex.Span.t()}
  | {:error, :disabled}
  | {:error, :no_trace_context}
  | {:error, [Optimal.error()]}

Updates the top-most parent span.

Any spans that have already been started will not inherit any of the updates from that span. For instance, if you change service, it will not be reflected in already-started spans.

In the case of an invalid update, validation errors are returned.