18aa2eca97 | ||
---|---|---|
.. | ||
config | ||
lib | ||
test | ||
.formatter.exs | ||
.gitignore | ||
CHANGELOG.md | ||
LICENSE | ||
README.md | ||
mix.exs | ||
mix.lock |
README.md
OpentelemetryPhoenix
Telemetry handler that creates Opentelemetry spans from Phoenix events.
After installing, setup the handler in your application behaviour before your top-level supervisor starts.
OpentelemetryPhoenix.setup()
See the documentation for OpentelemetryPhoenix.setup/1
for additional options that
may be supplied.
Installation
def deps do
[
{:opentelemetry_phoenix, "~> 1.0.0-rc"}
]
end
Note on phoenix integration
OpentelemetryPhoenix
requires phoenix to use Plug.Telemetry
in order to correctly trace endpoint calls.
The endpoint.ex
file should look like:
defmodule MyApp.Endpoint do
use Phoenix.Endpoint, otp_app: :my_app
...
plug Plug.Telemetry, event_prefix: [:phoenix, :endpoint]
...
end
The Phoenix endpoint.ex template can be used as a reference