Document Telemetry Events

lib/oidcc/provider_configuration.ex

@@ -1,6 +1,54 @@
 defmodule Oidcc.ProviderConfiguration do
+  use TelemetryRegistry
+
+  telemetry_event(%{
+    event: [:oidcc, :load_configuration, :start],
+    description: "Emitted at the start of loading the provider configuration",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :load_configuration, :stop],
+    description: "Emitted at the end of loading the provider configuration",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :load_configuration, :exception],
+    description: "Emitted at the end of loading the provider configuration",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :load_jwks, :start],
+    description: "Emitted at the start of loading the provider jwks",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{jwks_uri: :uri_string.uri_string()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :load_jwks, :stop],
+    description: "Emitted at the end of loading the provider jwks",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{jwks_uri: :uri_string.uri_string()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :load_jwks, :exception],
+    description: "Emitted at the end of loading the provider jwks",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{jwks_uri: :uri_string.uri_string()}"
+  })
+
   @moduledoc """
   Tooling to load and parse Openid Configuration
+
+  ## Telemetry
+
+  #{telemetry_docs()}
   """
 
   use Oidcc.RecordStruct,

lib/oidcc/token.ex

@@ -1,6 +1,96 @@
 defmodule Oidcc.Token do
+  use TelemetryRegistry
+
+  telemetry_event(%{
+    event: [:oidcc, :request_token, :start],
+    description: "Emitted at the start of requesting a code token",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :request_token, :stop],
+    description: "Emitted at the end of requesting a code token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :request_token, :exception],
+    description: "Emitted at the end of requesting a code token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :refresh_token, :start],
+    description: "Emitted at the start of refreshing a token",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :refresh_token, :stop],
+    description: "Emitted at the end of refreshing a token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :refresh_token, :exception],
+    description: "Emitted at the end of refreshing a token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :jwt_profile_token, :start],
+    description: "Emitted at the start of exchaning a JWT profile token",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :jwt_profile_token, :stop],
+    description: "Emitted at the end of exchaning a JWT profile token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :jwt_profile_token, :exception],
+    description: "Emitted at the end of exchaning a JWT profile token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :client_credentials, :start],
+    description: "Emitted at the start of requesting a client credentials token",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :client_credentials, :stop],
+    description: "Emitted at the end of requesting a client credentials token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :client_credentials, :exception],
+    description: "Emitted at the end of requesting a client credentials token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
   @moduledoc """
   Facilitate OpenID Code/Token Exchanges
+
+  ## Telemetry
+
+  #{telemetry_docs()}
   """
 
   use Oidcc.RecordStruct,

lib/oidcc/token_introspection.ex

@@ -1,8 +1,35 @@
 defmodule Oidcc.TokenIntrospection do
+  use TelemetryRegistry
+
+  telemetry_event(%{
+    event: [:oidcc, :introspect_token, :start],
+    description: "Emitted at the start of introspecting the token",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :introspect_token, :stop],
+    description: "Emitted at the end of introspecting the token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :introspect_token, :exception],
+    description: "Emitted at the end of introspecting the token",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
   @moduledoc """
   OAuth Token Introspection
 
   See https://datatracker.ietf.org/doc/html/rfc7662
+
+  ## Telemetry
+
+  #{telemetry_docs()}
   """
 
   use Oidcc.RecordStruct,

lib/oidcc/userinfo.ex

@@ -1,8 +1,35 @@
 defmodule Oidcc.Userinfo do
+  use TelemetryRegistry
+
+  telemetry_event(%{
+    event: [:oidcc, :userinfo, :start],
+    description: "Emitted at the start of loading userinfo",
+    measurements: "%{system_time: non_neg_integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :userinfo, :stop],
+    description: "Emitted at the end of loading userinfo",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
+  telemetry_event(%{
+    event: [:oidcc, :userinfo, :exception],
+    description: "Emitted at the end of loading userinfo",
+    measurements: "%{duration: integer(), monotonic_time: integer()}",
+    metadata: "%{issuer: :uri_string.uri_string(), client_id: String.t()}"
+  })
+
   @moduledoc """
   OpenID Connect Userinfo
 
   See https://openid.net/specs/openid-connect-core-1_0.html#UserInfo
+
+  ## Telemetry
+
+  #{telemetry_docs()}
   """
 
   alias Oidcc.ClientContext

mix.exs

@@ -30,6 +30,7 @@ defmodule Oidcc.Mixfile do
   defp deps() do
     [
       {:telemetry, "~> 1.2"},
+      {:telemetry_registry, "~> 0.3.1"},
       {:jose, "~> 1.11"},
       {:jsx, "~> 3.1"},
       {:mock, "~> 0.3.8", only: :test},

rebar.config

@@ -2,7 +2,12 @@
 
 {minimum_otp_vsn, "26"}.
 
-{deps, [{telemetry, "~> 1.2"}, {jose, "~> 1.11"}, {meck, "~> 0.9.2"}]}.
+{deps, [
+    {telemetry, "~> 1.2"},
+    {telemetry_registry, "~> 0.3.1"},
+    {jose, "~> 1.11"},
+    {meck, "~> 0.9.2"}
+]}.
 
 {project_plugins, [
     %% Revert back to released version when this PR is merged & released:

src/oidcc_provider_configuration.erl

@@ -1,11 +1,17 @@
 %%%-------------------------------------------------------------------
 %% @doc Tooling to load and parse Openid Configuration
 %%
+%% <h2>Records</h2>
+%%
 %% To use the record, import the definition:
 %%
 %% ```
 %% -include_lib(["oidcc/include/oidcc_provider_configuration.hrl"]).
 %% '''
+%%
+%% <h2>Telemetry</h2>
+%%
+%% See {@link 'Elixir.Oidcc.ProviderConfiguration'}
 %% @end
 %%%-------------------------------------------------------------------
 -module(oidcc_provider_configuration).
@@ -36,7 +42,7 @@
 %% </ul>
 
 -type t() ::
     #oidcc_provider_configuration{
         issuer :: uri_string:uri_string(),
         authorization_endpoint :: uri_string:uri_string(),
         token_endpoint :: uri_string:uri_string() | undefined,
@@ -116,6 +122,48 @@
 
 -define(DEFAULT_CONFIG_EXPIRY, timer:minutes(15)).
 
+-telemetry_event(#{
+    event => [oidcc, load_configuration, start],
+    description => <<"Emitted at the start of loading the provider configuration">>,
+    measurements => <<"#{system_time => non_neg_integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, load_configuration, stop],
+    description => <<"Emitted at the end of loading the provider configuration">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, load_configuration, exception],
+    description => <<"Emitted at the end of loading the provider configuration">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{issuer => uri_string:uri_string()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, load_jwks, start],
+    description => <<"Emitted at the start of loading the provider jwks">>,
+    measurements => <<"#{system_time => non_neg_integer()}">>,
+    metadata => <<"#{jwks_uri => uri_string:uri_string()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, load_jwks, stop],
+    description => <<"Emitted at the end of loading the provider jwks">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{jwks_uri => uri_string:uri_string()}">>
+}).
+
+-telemetry_event(#{
+    event => [oidcc, load_jwks, exception],
+    description => <<"Emitted at the end of loading the provider jwks">>,
+    measurements => <<"#{duration => integer(), monotonic_time => integer()}">>,
+    metadata => <<"#{jwks_uri => uri_string:uri_string()}">>
+}).
+
 %% @doc Load OpenID Configuration into a {@link oidcc_provider_configuration:t()} record
 %%
 %% <h2>Examples</h2>