Bump version to v0.2.0
1 file changed
tree: 2fd3d3a9d1135b2862cf75358f4dff720a3d851e
  1. include/
  2. src/
  3. test/
  4. .gitignore
  5. .travis.yml
  6. LICENSE
  7. README.md
  8. rebar.config
  9. rebar.lock
README.md

passage

hex.pm version Build Status Code Coverage License: MIT

OpenTraceing API for Erlang

Documentation

Examples

%% Registers `tracer`
Context = passage_span_context_null,
Sampler = passage_sampler_all:new(),
Reporter = passage_reporter_process:new(self(), span),
ok = passage_tracer_registry:register(tracer, Context, Sampler, Reporter),

%% Starts a root span
RootSpan = passage:start_span(example_root, [{tracer, tracer}]),

%% Starts a child span
ChildSpan = passage:start_span(example_child, [{child_of, RootSpan}]),

%% Finishes spans
passage:finish_span(ChildSpan),
passage:finish_span(RootSpan),

%% Receives the finished spans
receive {span, FinishedChildSpan} -> ok end,
receive {span, FinishedRootSpan} -> ok end.

Process Dictionary Version

%% Registers `tracer`
Context = passage_span_context_null,
Sampler = passage_sampler_all:new(),
Reporter = passage_reporter_process:new(self(), span),
ok = passage_tracer_registry:register(tracer, Context, Sampler, Reporter),

%% Starts a root span
ok = passage_pd:start_span(example_root, [{tracer, tracer}]),

%% Starts a child span
ok = passage_pd:start_span(example_child),

%% Finishes spans
passage_pd:finish_span(),  % child
passage_pd:finish_span(),  % root

%% Receives the finished spans
receive {span, FinishedChildSpan} -> ok end,
receive {span, FinishedRootSpan} -> ok end.

Parse Transform

-module(example).

-compile({parse_transform, passage_transform}). % Enables `passage_transform'

-passage_trace([{tags, #{foo => "bar", size => "byte_size(Bin)"}}]).
-spec foo(binary()) -> binary().
foo(Bin) ->
  <<"foo", Bin/binary>>.

The above foo function will be transformed as follows:

foo(Bin) ->
  passage_pd:start_span('example:foo/1', []),
  try
    passage_pd:set_tags(
        fun () ->
            #{
                'location.pid' => self(),
                'location.application' => example,
                'location.module' => example,
                'location.line' => 7
                foo => bar,
                size => byte_size(Bin)
             }
        end),
    <<"foo", Bin/binary>>
  after
    passage_pd:finish_span()
  end.

References