opentelemetry-erlang-contrib/instrumentation/opentelemetry_phoenix
Seth Archer Brown f083f3d7e7
Remove outdate setup example (#30)
Co-authored-by: Bryan Naegele <bryannaegele@users.noreply.github.com>
2021-10-15 14:11:28 -06:00
..
config Otel 1.0.0-rc.3 support (#27) 2021-10-13 21:11:26 -06:00
lib Remove outdate setup example (#30) 2021-10-15 14:11:28 -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 Lock Otel versions and publish updates (#22) 2021-10-08 16:27:42 -06:00
LICENSE Otel phoenix migration (#4) 2021-09-12 13:49:24 -06:00
README.md Otel 1.0.0-rc.3 support (#27) 2021-10-13 21:11:26 -06:00
mix.exs Otel 1.0.0-rc.3 support (#27) 2021-10-13 21:11:26 -06:00
mix.lock Publish packages (#28) 2021-10-15 14:01:11 -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.5"}
  ]
end

Compatibility Matrix

OpentelemetryPhoenix Version Otel Version Notes
v0.1.0 <= v.0.5.0
v1.0.0-rc.3 v1.0.0-rc.1
v1.0.0-rc.2
v1.0.0-rc.4 v1.0.0-rc.2 Otel rc.3 will be a breaking change
v1.0.0-rc.5 v1.0.0-rc.3

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