Tapper

v0.6.2

Tapper v0.6.2 Tapper.Tracer.Api behaviour View Source

The (minimal) low-level API for the Tapper.Tracer; clients will normally use the Tapper module.

Link to this section Summary

Types

annotation_delta()

Delta for simple annotations

annotation_value()
async_delta()

Delta for async span

binary_annotation_delta()

Delta for binary annotations

binary_annotation_key()
binary_annotation_type()
binary_annotation_value()
delta()
maybe_endpoint()
name_delta()

Delta for span name

span_type()

Denote a client span or a server span; used to automatically add :sr or :cs annotation.

Callbacks

finish(tapper_id, opts)
finish_span(tapper_id, opts)
join(trace_id, span_id, parent_id, sample, debug, opts)
start(opts)
start_span(tapper_id, opts)
update_span(tapper_id, deltas, opts)

Link to this section Types

Link to this type

annotation_delta()

View Source

Specs

annotation_delta() ::
  {:annotate, {value :: annotation_value(), endpoint :: maybe_endpoint()}}
  | annotation_value()

Delta for simple annotations

Link to this type

annotation_value()

View Source

Specs

annotation_value() :: String.t() | atom()
Link to this type

async_delta()

View Source

Specs

async_delta() :: {:async, boolean()}

Delta for async span

Link to this type

binary_annotation_delta()

View Source

Specs

binary_annotation_delta() ::
  {:binary_annotate,
   {type :: binary_annotation_type(), key :: binary_annotation_key(),
    value :: binary_annotation_value(), endpoint :: maybe_endpoint()}}

Delta for binary annotations

Link to this type

binary_annotation_key()

View Source

Specs

binary_annotation_key() :: String.t() | atom()
Link to this type

binary_annotation_type()

View Source

Specs

binary_annotation_type() ::
  :string | :bool | :i16 | :i32 | :i64 | :double | :bytes
Link to this type

binary_annotation_value()

View Source

Specs

binary_annotation_value() ::
  String.t() | atom() | boolean() | integer() | float() | binary()
Link to this type

delta()

View Source

Specs

delta() ::
  name_delta() | async_delta() | annotation_delta() | binary_annotation_delta()
Link to this type

maybe_endpoint()

View Source

Specs

maybe_endpoint() :: Tapper.Endpoint.t() | nil
Link to this type

name_delta()

View Source

Specs

name_delta() :: {:name, name :: String.t() | atom()}

Delta for span name

Link to this type

span_type()

View Source

Specs

span_type() :: :client | :server

Denote a client span or a server span; used to automatically add :sr or :cs annotation.

Link to this section Callbacks

Link to this callback

finish(tapper_id, opts)

View Source

Specs

finish(tapper_id :: Tapper.Id.t(), opts :: Keyword.t()) :: :ok
Link to this callback

finish_span(tapper_id, opts)

View Source

Specs

finish_span(tapper_id :: Tapper.Id.t(), opts :: Keyword.t()) :: Tapper.Id.t()
Link to this callback

join(trace_id, span_id, parent_id, sample, debug, opts)

View Source

Specs

join(
  trace_id :: Tapper.TraceId.t(),
  span_id :: Tapper.SpanId.t(),
  parent_id :: Tapper.SpanId.t() | :root,
  sample :: boolean(),
  debug :: boolean(),
  opts :: Keyword.t()
) :: Tapper.Id.t()
Link to this callback

start(opts)

View Source

Specs

start(opts :: Keyword.t()) :: Tapper.Id.t()
Link to this callback

start_span(tapper_id, opts)

View Source

Specs

start_span(tapper_id :: Tapper.Id.t(), opts :: Keyword.t()) :: Tapper.Id.t()
Link to this callback

update_span(tapper_id, deltas, opts)

View Source

Specs

update_span(
  tapper_id :: Tapper.Id.t(),
  deltas :: delta() | [delta()],
  opts :: Keyword.t()
) :: Tapper.Id.t()