Annotation helper: create an event annotation, general interface.

Annotation helper: mark the span as asynchronous, and add an async event annotation.

Adding this annotation is semantically equivalent to calling finish/2 with the async option, and instigates the same time-out behaviour.

You would probably add one of these to every asynchronous span, so we know which spans were async.

Ensure that child spans, and the whole trace, are finished as normal.

Example

# start a trace
id = Tapper.start(name: "main")

# spawn a task
ref = Task.start(fn ->
  # start a child span in the task
  child_id = Tapper.start_span(id, "fetch", annotations: Tapper.async())
  res = do_something()
  {res, child_id}
end)

# finish the trace, this won't send the spans; note we don't need async: true
# if Task has already called start_span(), but it might not have, so safer to do so!
Tapper.finish(id, async: true)
...
# await the result from our task
{res, span_id} = Task.await(ref)
send_result_to_queue_or_something(res)

# finish the child span; will complete trace and send spans
Tapper.finish_span(span_id)

See also

• Tapper.Tracer.Timeout
• Tapper.finish/2

Annotation helper: create a general binary annotation.

type is one of: :string, :bool, :i16, :i32, :i64, :double, :bytes

Example

binary_annotation(id, :i16, "tab", 4)

Annotation helper: tag the client's address (ca binary annotation).

Annotation helper: create a client_receive event (cr event annotation).

Annotation helper: create a client_send event (cs event annotation); see also :client option on Tapper.start/1.

Get the in-context Tapper.Id of this process.

If the context does not exist, and :tapper configuration option :debug_context is is :warn will log a warning with stack-trace, if otherwise truthy, will raise a RuntimeError, else will just return :ignore.

determine if there is a Tapper.Id in context

delete the in-context Tapper.Id

Annotation helper: create an error event (error event annotation).

Annotation helper: tag with an error message (error binary annotation)

Finishes the trace, for the current contextual Tapper.Id, removing the id from the process context.

See Tapper.Tracer.finish/2 for options.

Finish a nested span of the current contextual Tapper.Id, returning an updated Tapper.Id, and updating the id in the context.

See Tapper.Tracer.finish_span/2 for options.

Annotation helper: tag with HTTP host information (http.host binary annotation).

Annotation helper: tag with HTTP method information (http.method binary annotation).

Annotation helper: tag with HTTP path information: should be without query parameters (http.path binary annotation)

Annotation helper: tag with an HTTP request size (http.request.size binary annotation)

Annotation helper: tag with an HTTP reponse size (http.response.size binary annotation)

Annotation helper: tag with an HTTP status code (http.status_code binary annotation)

Annotation helper: tag with full HTTP URL information (http.url binary annotation)

Joins an existing trace, e.g. server recieving an annotated request.

A Tapper.Id is returned, and stored it in the process context.

id = Tapper.Ctx.join(trace_id, span_id, parent_id, sample, debug, name: "receive request")
^id = Tapper.Ctx.context()

See Tapper.Tracer.join/6 for options.

Annotation helper: name (or rename) the current span.

Set the in-context Tapper.Id of this process.

Annotation helper: tag with the server's address (sa binary annotation).

Annotation helper: create a server_receive event (sr event annotation); see also :server option on Tapper.start/1.

Annotation helper: create a server_send event (ss event annotation).

Annotation helper: tag with a database query (sql.query binary annotation)

Starts a new root trace, e.g. on originating a request.

A new Tapper.Id is returned, and stored in the process context, see Tapper.Ctx.put_context/1.

id = Tapper.Ctx.start(name: "request resource", type: :client, remote: remote_endpoint)
^id = Tapper.Ctx.context()

See Tapper.Tracer.start/1 for options.

Starts a child span of the current span of the current contextual Tapper.Id, returning an updated Tapper.Id, and updating the id in the context.

See Tapper.Tracer.start_span/2 for options.

Annotation helper: tag with a general (key,value,host) binary annotation, determining type of annotation automatically

Add annotations to the current contextual span, returning the same Tapper.Id.

See Tapper.Tracer.update_span/3 for details.

Annotation helper: create a receive event (wr event annotation).

Annotation helper: create a send event (ws event annotation).