Document PAR Telemetry Events (#345)

erlef · Apr 30, 2024 · e9d6b9b · e9d6b9b
1 parent 206090e
commit e9d6b9b
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/lib/oidcc/authorization.ex b/lib/oidcc/authorization.ex
@@ -1,6 +1,33 @@
 defmodule Oidcc.Authorization do
+  use TelemetryRegistry
+
+  telemetry_event(%{
+    event: [:oidcc, :par_request, :start],
+    description: "Emitted at the start of executing a PAR request",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :par_request, :stop],
+    description: "Emitted at the end of executing a PAR request",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :par_request, :exception],
+    description: "Emitted at the end of executing a PAR request",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
   @moduledoc """
   Functions to start an OpenID Connect Authorization
+
+  ## Telemetry
+
+  #{telemetry_docs()}
   """
   @moduledoc since: "3.0.0"
 

diff --git a/src/oidcc_authorization.erl b/src/oidcc_authorization.erl
@@ -60,6 +60,27 @@
     | no_supported_code_challenge
     | oidcc_http_util:error().
 
+-telemetry_event(#{
+    event => [oidcc, par_request, start],
+    description => <<"Emitted at the start of executing a PAR request">>,
+    measurements => <<"#{system_time => non_neg_integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string(), client_id => binary()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, par_request, stop],
+    description => <<"Emitted at the end of executing a PAR request">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string(), client_id => binary()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, par_request, exception],
+    description => <<"Emitted at the end of executing a PAR request">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string(), client_id => binary()}">>
+}).
+
 %% @doc
 %% Create Auth Redirect URL
 %%