opentelemetry_api v1.3.0

View Source otel_tracer behaviour (opentelemetry_api v1.3.0)

Link to this section Summary

Types

traced_fun/1

Callbacks

start_span/4
with_span/5

Functions

current_span_ctx()
current_span_ctx(Ctx)
from_remote_span(TraceId, SpanId, Traceflags)
Returns a span_ctx record with is_recording set to false and is_remote set to true. This is mainly for use in propagators when they extract a Span to be used as a parent.
non_recording_span(TraceId, SpanId, Traceflags)
Returns a span_ctx record with is_recording set to false. This is mainly for use in propagators when they extract a Span to be used as a parent.
set_current_span(SpanCtx)
set_current_span(Ctx, SpanCtx)
start_span(Tracer, SpanName, Opts)
start_span(Ctx, Tracer, SpanName, Opts)
update_logger_process_metadata(Ctx)
with_span(Tracer, SpanName, Opts, Fun)
with_span(Ctx, Tracer, SpanName, Opts, Fun)

Link to this section Types

Link to this type

traced_fun/1

View Source 
-type traced_fun(T) :: fun((opentelemetry:span_ctx()) -> T).

Link to this section Callbacks

Link to this callback

start_span/4

View Source 
-callback start_span(otel_ctx:t(),
           opentelemetry:tracer(),
           opentelemetry:span_name(),
           otel_span:start_opts()) ->
              opentelemetry:span_ctx().
Link to this callback

with_span/5

View Source 
-callback with_span(otel_ctx:t(),
          opentelemetry:tracer(),
          opentelemetry:span_name(),
          otel_span:start_opts(),
          traced_fun(T)) ->
             T.

Link to this section Functions

Link to this function

current_span_ctx()

View Source 
-spec current_span_ctx() -> opentelemetry:span_ctx() | undefined.
Link to this function

current_span_ctx(Ctx)

View Source 
-spec current_span_ctx(otel_ctx:t()) -> opentelemetry:span_ctx() | undefined.
Link to this function

from_remote_span(TraceId, SpanId, Traceflags)

View Source 
-spec from_remote_span(opentelemetry:trace_id(), opentelemetry:span_id(), opentelemetry:trace_flags()) ->
                    opentelemetry:span_ctx().
Returns a span_ctx record with is_recording set to false and is_remote set to true. This is mainly for use in propagators when they extract a Span to be used as a parent.
Link to this function

non_recording_span(TraceId, SpanId, Traceflags)

View Source 
-spec non_recording_span(opentelemetry:trace_id(), opentelemetry:span_id(), opentelemetry:trace_flags()) ->
                      opentelemetry:span_ctx().
Returns a span_ctx record with is_recording set to false. This is mainly for use in propagators when they extract a Span to be used as a parent.
Link to this function

set_current_span(SpanCtx)

View Source 
-spec set_current_span(opentelemetry:span_ctx() | undefined) -> opentelemetry:span_ctx() | undefined.
Link to this function

set_current_span(Ctx, SpanCtx)

View Source 
-spec set_current_span(otel_ctx:t(), opentelemetry:span_ctx() | undefined) -> otel_ctx:t().
Link to this function

start_span(Tracer, SpanName, Opts)

View Source 
-spec start_span(opentelemetry:tracer(), opentelemetry:span_name(), otel_span:start_opts()) ->
              opentelemetry:span_ctx().
Link to this function

start_span(Ctx, Tracer, SpanName, Opts)

View Source 
-spec start_span(otel_ctx:t(),
           opentelemetry:tracer(),
           opentelemetry:span_name(),
           otel_span:start_opts()) ->
              opentelemetry:span_ctx().
Link to this function

update_logger_process_metadata(Ctx)

View Source
Link to this function

with_span(Tracer, SpanName, Opts, Fun)

View Source 
-spec with_span(opentelemetry:tracer(),
          opentelemetry:span_name(),
          otel_span:start_opts(),
          traced_fun(T)) ->
             T.
Link to this function

with_span(Ctx, Tracer, SpanName, Opts, Fun)

View Source 
-spec with_span(otel_ctx:t(),
          opentelemetry:tracer(),
          opentelemetry:span_name(),
          otel_span:start_opts(),
          traced_fun(T)) ->
             T.