add spec for liveview option (#460)

open-telemetry · Jan 24, 2025 · b610422 · b610422
1 parent b6c577b
commit b610422
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/instrumentation/opentelemetry_phoenix/lib/opentelemetry_phoenix.ex b/instrumentation/opentelemetry_phoenix/lib/opentelemetry_phoenix.ex
@@ -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.
   """