History

Patrik Stenmark ddf0706bf1 Make exdocs settings a bit more similar between different packages (#168 ) * Add source_url_pattern to be able to use the "link to source" button * Add README.md as an "extra" where it wasn't already * Add a `main` setting. They all have a very obvious main module. Set that as `main`, so a user is shown this immediately instead of a list of usually only this module.		2023-04-30 12:10:03 -06:00
..
config	Remove exporter race-condition on tests (#44 )	2022-03-24 11:48:59 -06:00
lib	Phoenix 1.1.0 (#145 )	2023-01-13 14:38:05 -07:00
test	chore: add semantic conventions to phoenix (#121 )	2022-12-12 13:51:54 -07: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	Phoenix 1.1.0 (#145 )	2023-01-13 14:38:05 -07:00
LICENSE	Otel phoenix migration (#4 )	2021-09-12 13:49:24 -06:00
README.md	Phoenix 1.1.0 (#145 )	2023-01-13 14:38:05 -07:00
mix.exs	Make exdocs settings a bit more similar between different packages (#168 )	2023-04-30 12:10:03 -06:00
mix.lock	Phoenix Plug.Cowboy adapter support (#144 )	2023-01-06 13:46:06 -07:00

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.1"}
  ]
end

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
v1.0.0-rc.6	v1.0.0-rc.4
v1.0	v1.0

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