opentelemetry_api v1.1.1

View Source otel_span (opentelemetry_api v1.1.1)

Span behaviour.

Link to this section Summary

Types

start_opts/0

Functions

add_event(SpanCtx, Name, Attributes)
add_events(SpanCtx, Events)
end_span(SpanCtx)
end_span(SpanCtx, Timestamp)
hex_span_ctx(Span_ctx)
hex_span_id(Span_ctx)
hex_trace_id(Span_ctx)
is_recording(SpanCtx)
is_valid(SpanCtx)
is_valid_name(Name)
process_attributes(Attributes)
record_exception(SpanCtx, Class, Term, Stacktrace, Attributes)
record_exception(SpanCtx, Class, Term, Message, Stacktrace, Attributes)
set_attribute(SpanCtx, Key, Value)
set_attributes(SpanCtx, Attributes)
set_status(SpanCtx, Status)
set_status(SpanCtx, Code, Message)
span_id(Span_ctx)
trace_id(Span_ctx)
tracestate(Span_ctx)
update_name(SpanCtx, Name)
validate_start_opts(Opts)

Link to this section Types

Link to this type

start_opts/0

View Source 
-type start_opts() ::
    #{attributes => opentelemetry:attributes_map(),
      links => [opentelemetry:link()],
      is_recording => boolean(),
      start_time => opentelemetry:timestamp(),
      kind => opentelemetry:span_kind()}.

Link to this section Functions

Link to this function

add_event(SpanCtx, Name, Attributes)

View Source 
-spec add_event(SpanCtx, Name, Attributes) -> boolean()
             when
                 Name :: opentelemetry:event_name(),
                 Attributes :: opentelemetry:attributes_map(),
                 SpanCtx :: opentelemetry:span_ctx().
Link to this function

add_events(SpanCtx, Events)

View Source 
-spec add_events(SpanCtx, Events) -> boolean()
              when Events :: [opentelemetry:event()], SpanCtx :: opentelemetry:span_ctx().
Link to this function

end_span(SpanCtx)

View Source 
-spec end_span(SpanCtx) -> SpanCtx when SpanCtx :: opentelemetry:span_ctx().
Link to this function

end_span(SpanCtx, Timestamp)

View Source 
-spec end_span(SpanCtx, Timestamp) -> SpanCtx
            when SpanCtx :: opentelemetry:span_ctx(), Timestamp :: integer() | undefined.
Link to this function

hex_span_ctx(Span_ctx)

View Source 
-spec hex_span_ctx(opentelemetry:span_ctx() | undefined) ->
                #{otel_trace_id := unicode:charlist(),
                  otel_span_id := unicode:charlist(),
                  otel_trace_flags := unicode:charlist()} |
                #{}.
Link to this function

hex_span_id(Span_ctx)

View Source 
-spec hex_span_id(opentelemetry:span_ctx()) -> opentelemetry:hex_span_id().
Link to this function

hex_trace_id(Span_ctx)

View Source 
-spec hex_trace_id(opentelemetry:span_ctx()) -> opentelemetry:hex_trace_id().
Link to this function

is_recording(SpanCtx)

View Source 
-spec is_recording(SpanCtx) -> boolean() when SpanCtx :: opentelemetry:span_ctx().
Link to this function

is_valid(SpanCtx)

View Source 
-spec is_valid(SpanCtx) -> boolean() when SpanCtx :: opentelemetry:span_ctx().
Link to this function

is_valid_name(Name)

View Source 
-spec is_valid_name(any()) -> boolean().
Link to this function

process_attributes(Attributes)

View Source 
-spec process_attributes(any()) -> opentelemetry:attributes_map().
Link to this function

record_exception(SpanCtx, Class, Term, Stacktrace, Attributes)

View Source 
-spec record_exception(SpanCtx, Class, Term, Stacktrace, Attributes) -> boolean()
                    when
                        SpanCtx :: opentelemetry:span_ctx(),
                        Class :: atom(),
                        Term :: term(),
                        Stacktrace :: [any()],
                        Attributes :: opentelemetry:attributes_map().
Link to this function

record_exception(SpanCtx, Class, Term, Message, Stacktrace, Attributes)

View Source 
-spec record_exception(SpanCtx, Class, Term, Message, Stacktrace, Attributes) -> boolean()
                    when
                        SpanCtx :: opentelemetry:span_ctx(),
                        Class :: atom(),
                        Term :: term(),
                        Message :: unicode:unicode_binary(),
                        Stacktrace :: [any()],
                        Attributes :: opentelemetry:attributes_map().
Link to this function

set_attribute(SpanCtx, Key, Value)

View Source 
-spec set_attribute(SpanCtx, Key, Value) -> boolean()
                 when
                     Key :: opentelemetry:attribute_key(),
                     Value :: opentelemetry:attribute_value(),
                     SpanCtx :: opentelemetry:span_ctx().
Link to this function

set_attributes(SpanCtx, Attributes)

View Source 
-spec set_attributes(SpanCtx, Attributes) -> boolean()
                  when
                      Attributes :: opentelemetry:attributes_map(),
                      SpanCtx :: opentelemetry:span_ctx().
Link to this function

set_status(SpanCtx, Status)

View Source 
-spec set_status(SpanCtx, Status) -> boolean()
              when
                  Status :: opentelemetry:status() | undefined,
                  SpanCtx :: opentelemetry:span_ctx().
Link to this function

set_status(SpanCtx, Code, Message)

View Source 
-spec set_status(SpanCtx, Code, Message) -> boolean()
              when
                  Code :: opentelemetry:status_code(),
                  Message :: unicode:unicode_binary(),
                  SpanCtx :: opentelemetry:span_ctx().
Link to this function

span_id(Span_ctx)

View Source 
-spec span_id(opentelemetry:span_ctx()) -> opentelemetry:span_id().
Link to this function

trace_id(Span_ctx)

View Source 
-spec trace_id(opentelemetry:span_ctx()) -> opentelemetry:trace_id().
Link to this function

tracestate(Span_ctx)

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

update_name(SpanCtx, Name)

View Source 
-spec update_name(SpanCtx, Name) -> boolean()
               when Name :: opentelemetry:span_name(), SpanCtx :: opentelemetry:span_ctx().
Link to this function

validate_start_opts(Opts)

View Source 
-spec validate_start_opts(start_opts()) -> start_opts().