Skip to content

add spec for liveview option to OpentelemetryPhoenix #460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 24, 2025
Merged

add spec for liveview option to OpentelemetryPhoenix #460

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion instrumentation/opentelemetry_phoenix/lib/opentelemetry_phoenix.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,17 @@ defmodule OpentelemetryPhoenix do
@tracer_id __MODULE__

@typedoc "Setup options"
@type opts :: [endpoint_prefix() | adapter()]
@type opts :: [endpoint_prefix() | adapter() | liveview()]

@typedoc "The endpoint prefix in your endpoint. Defaults to `[:phoenix, :endpoint]`"
@type endpoint_prefix :: {:endpoint_prefix, [atom()]}

@typedoc "The phoenix server adapter being used. Required"
@type adapter :: {:adapter, :cowboy2 | :bandit}

@typedoc "Attach LiveView handlers. Optional"
@type liveview :: {:liveview, boolean()}

@doc """
Initializes and configures the telemetry handlers.
"""
Expand Down
Loading