Module ottersp

This API uses the process dictionary to collect span information and can be used when all span tags an events happen in the same request handling process.

Description

This API uses the process dictionary to collect span information and can be used when all span tags an events happen in the same request handling process.

Function Index

finish/0 Ends the span and prepares queues it to be dispatched to the trace server.
get_span/0
ids/0 Retrives the Trace ID and the Span ID from a span.
log/1 Adds a tag to the span, possibly overwriting the existing value.
log/2 Adds the log to a span with a given service, possibly overwriting the existing value.
start/1 Starts a new span with a given name and a generated trace id.
start/2 Starts a new span with a given Trace ID.
start/3 Starts a new span with a given Trace ID and Parent ID.
start_child/2 Starts a new span as a child of a existing span, using the parents Trace ID and setting the childs parent to the parents Span ID.
tag/2 Adds a tag to the span, possibly overwriting the existing value.
tag/3 Adds a tag to the span, possibly overwriting the existing value.

Function Details

finish/0

finish() -> ok

Ends the span and prepares queues it to be dispatched to the trace server.

get_span/0

get_span() -> otters:maybe_span()

ids/0

ids() -> {otters:trace_id(), otters:span_id()} | undefined

Retrives the Trace ID and the Span ID from a span.

log/1

log(Text::otters:info()) -> ok

Adds a tag to the span, possibly overwriting the existing value.

log/2

log(Text::otters:info(), Service::otters:service()) -> ok

Adds the log to a span with a given service, possibly overwriting the existing value.

start/1

start(Name::otters:info()) -> ok

Starts a new span with a given name and a generated trace id.

start/2

start(Name::otters:info(), TraceId::otters:trace_id()) -> ok

Starts a new span with a given Trace ID.

start/3

start(Name::otters:info(), TraceId::otters:trace_id(), ParentId::otters:span_id()) -> ok

Starts a new span with a given Trace ID and Parent ID.

start_child/2

start_child(Name::otters:info(), ParentSpan::otters:maybe_span()) -> otters:maybe_span()

Starts a new span as a child of a existing span, using the parents Trace ID and setting the childs parent to the parents Span ID

tag/2

tag(Key::otters:info(), Value::otters:info()) -> ok

Adds a tag to the span, possibly overwriting the existing value.

tag/3

tag(Key::otters:info(), Value::otters:info(), Service::otters:service()) -> ok

Adds a tag to the span, possibly overwriting the existing value.


Generated by EDoc, Apr 9 2017, 12:54:36.