opentelemetry-erlang-contrib/instrumentation/opentelemetry_phoenix
Marco "Efesto" Polita 3334b07b9d
Adds readme entry on Plug.Telemetry (#20)
* adds entry about Plug.Telemetry

* Adds reference to phoenix endpoint template
2021-10-01 10:30:49 -06:00
..
config Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
lib Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
test Update otel-phoenix deps (#9) 2021-09-19 17:51:51 -06:00
.formatter.exs Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
.gitignore Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
CHANGELOG.md Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
LICENSE Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
README.md Adds readme entry on Plug.Telemetry (#20) 2021-10-01 10:30:49 -06:00
mix.exs opentelemetry-phoenix 1.0.0-rc3 (#15) 2021-09-19 18:17:51 -06:00
mix.lock Update otel-phoenix deps (#9) 2021-09-19 17:51:51 -06:00

README.md

OpentelemetryPhoenix

EEF Observability WG project Hex.pm Build Status

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