Appsignal.Tracer (AppSignal v2.1.7) View Source

Link to this section Summary

Types

Functions

Closes a span and deregisters it.

Closes a span and deregisters it. Takes an options list, which currently only accepts a List with an :end_time integer.

create_span(namespace)

Creates a new root span.

create_span(namespace, parent)

Creates a new child span.

create_span(namespace, parent, options)

Creates a new span, with an optional parent or pid.

current_span()

Returns the current span in the current process.

current_span(pid)

Returns the current span in the passed pid's process.

delete(pid)

Removes the process' spans from the registry.

ignore()

Ignores the current process.

lookup(pid)

Finds the span in the registry table.

root_span()

Returns the root span in the current process.

root_span(pid)

Returns the root span in the passed pid's process.

Link to this section Types

option()

Specs

option() :: {:pid, pid()} | {:start_time, integer()}

options()

Specs

options() :: [option()]

Link to this section Functions

close_span(span)

Specs

close_span(Appsignal.Span.t() | nil) :: :ok | nil

Closes a span and deregisters it.

Example

Appsignal.Tracer.current_span()
|> Appsignal.Tracer.close_span()

close_span(span, options)

Specs

close_span(Appsignal.Span.t() | nil, list()) :: :ok | nil

Closes a span and deregisters it. Takes an options list, which currently only accepts a List with an :end_time integer.

Example

Appsignal.Tracer.current_span()
|> Appsignal.Tracer.close_span(end_time: :os.system_time())

create_span(namespace)

Specs

create_span(String.t()) :: Appsignal.Span.t() | nil

Creates a new root span.

Example

Appsignal.Tracer.create_span("http_request")

create_span(namespace, parent)

Specs

create_span(String.t(), Appsignal.Span.t() | nil) :: Appsignal.Span.t() | nil

Creates a new child span.

Example

parent = Appsignal.Tracer.current_span()

Appsignal.Tracer.create_span("http_request", parent)

create_span(namespace, parent, options)

Specs

create_span(String.t(), Appsignal.Span.t() | nil, options()) ::
  Appsignal.Span.t() | nil

Creates a new span, with an optional parent or pid.

Example

parent = Appsignal.Tracer.current_span()

Appsignal.Tracer.create_span("http_request", parent, [start_time: :os.system_time(), pid: self()])

current_span()

Specs

current_span() :: Appsignal.Span.t() | nil

Returns the current span in the current process.

current_span(pid)

Specs

current_span(pid()) :: Appsignal.Span.t() | nil

Returns the current span in the passed pid's process.

delete(pid)

Specs

delete(pid()) :: :ok

Removes the process' spans from the registry.

ignore()

Specs

ignore() :: :ok | nil

Ignores the current process.

lookup(pid)

Specs

lookup(pid()) :: list()

Finds the span in the registry table.

root_span()

Specs

root_span() :: Appsignal.Span.t() | nil

Returns the root span in the current process.

root_span(pid)

Specs

root_span(pid()) :: Appsignal.Span.t() | nil

Returns the root span in the passed pid's process.