{"id":18616736,"url":"https://github.com/sile/passage","last_synced_at":"2025-04-11T01:32:08.751Z","repository":{"id":46529174,"uuid":"107689566","full_name":"sile/passage","owner":"sile","description":"OpenTracing API for Erlang","archived":false,"fork":false,"pushed_at":"2018-12-25T13:48:46.000Z","size":85,"stargazers_count":5,"open_issues_count":0,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-23T02:48:15.197Z","etag":null,"topics":["erlang","opentracing"],"latest_commit_sha":null,"homepage":"","language":"Erlang","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sile.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-20T14:41:35.000Z","updated_at":"2023-07-25T14:12:18.000Z","dependencies_parsed_at":"2022-07-19T22:34:05.693Z","dependency_job_id":null,"html_url":"https://github.com/sile/passage","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sile%2Fpassage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sile%2Fpassage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sile%2Fpassage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sile%2Fpassage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sile","download_url":"https://codeload.github.com/sile/passage/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248111368,"owners_count":21049570,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["erlang","opentracing"],"created_at":"2024-11-07T03:37:45.392Z","updated_at":"2025-04-11T01:32:08.425Z","avatar_url":"https://github.com/sile.png","language":"Erlang","funding_links":[],"categories":[],"sub_categories":[],"readme":"passage\n=======\n\n[![hex.pm version](https://img.shields.io/hexpm/v/passage.svg)](https://hex.pm/packages/passage)\n[![Build Status](https://travis-ci.org/sile/passage.svg?branch=master)](https://travis-ci.org/sile/passage)\n[![Code Coverage](https://codecov.io/gh/sile/passage/branch/master/graph/badge.svg)](https://codecov.io/gh/sile/passage/branch/master)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\n[OpenTracing](http://opentracing.io/) API for Erlang\n\n[Documentation](https://hexdocs.pm/passage/)\n\nExamples\n---------\n\n```erlang\n%% Registers `tracer`\nContext = passage_span_context_null,\nSampler = passage_sampler_all:new(),\nReporter = passage_reporter_process:new(self(), span),\nok = passage_tracer_registry:register(tracer, Context, Sampler, Reporter),\n\n%% Starts a root span\nRootSpan = passage:start_span(example_root, [{tracer, tracer}]),\n\n%% Starts a child span\nChildSpan = passage:start_span(example_child, [{child_of, RootSpan}]),\n\n%% Finishes spans\npassage:finish_span(ChildSpan),\npassage:finish_span(RootSpan),\n\n%% Receives the finished spans\nreceive {span, FinishedChildSpan} -\u003e ok end,\nreceive {span, FinishedRootSpan} -\u003e ok end.\n```\n\n### Process Dictionary Version\n\n```erlang\n%% Registers `tracer`\nContext = passage_span_context_null,\nSampler = passage_sampler_all:new(),\nReporter = passage_reporter_process:new(self(), span),\nok = passage_tracer_registry:register(tracer, Context, Sampler, Reporter),\n\n%% Starts a root span\nok = passage_pd:start_span(example_root, [{tracer, tracer}]),\n\n%% Starts a child span\nok = passage_pd:start_span(example_child),\n\n%% Finishes spans\npassage_pd:finish_span(),  % child\npassage_pd:finish_span(),  % root\n\n%% Receives the finished spans\nreceive {span, FinishedChildSpan} -\u003e ok end,\nreceive {span, FinishedRootSpan} -\u003e ok end.\n```\n\n### Parse Transform\n\n```erlang\n-module(example).\n\n-compile({parse_transform, passage_transform}). % Enables `passage_transform'\n-compile({passage_default_tracer, \"foo_tracer\"}). % Specifies the default tracer (optional)\n\n-passage_trace([{tags, #{foo =\u003e \"bar\", size =\u003e \"byte_size(Bin)\"}}]).\n-spec foo(binary()) -\u003e binary().\nfoo(Bin) -\u003e\n  \u003c\u003c\"foo\", Bin/binary\u003e\u003e.\n```\n\nThe above `foo` function will be transformed as follows:\n```erlang\nfoo(Bin) -\u003e\n  passage_pd:start_span('example:foo/1', []),\n  try\n    passage_pd:set_tags(\n        fun () -\u003e\n            #{\n                'location.pid' =\u003e self(),\n                'location.application' =\u003e example,\n                'location.module' =\u003e example,\n                'location.line' =\u003e 7\n                foo =\u003e bar,\n                size =\u003e byte_size(Bin)\n             }\n        end),\n    \u003c\u003c\"foo\", Bin/binary\u003e\u003e\n  after\n    passage_pd:finish_span()\n  end.\n```\n\nReferences\n-----------\n\n- [The OpenTracing Semantic Specification(v1.1)](https://github.com/opentracing/specification/blob/1.1/specification.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsile%2Fpassage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsile%2Fpassage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsile%2Fpassage/lists"}