Add telemetry

src/Clerk/BackendAPI/Hooks/ClerkBeforeRequestHook.cs

@@ -5,10 +5,10 @@ namespace Clerk.BackendAPI.Hooks
 
     public class ClerkBeforeRequestHook : IBeforeRequestHook
     {
-        public async Task<HttpRequestMessage> BeforeRequestAsync(BeforeRequestContext hookCtx, HttpRequestMessage request)
+        public Task<HttpRequestMessage> BeforeRequestAsync(BeforeRequestContext hookCtx, HttpRequestMessage request)
         {
             request.Headers.Add("Clerk-API-Version", "2024-10-01");
-            return request;
+            return Task.FromResult(request);
         }
     }
 }

src/Clerk/BackendAPI/Hooks/HookRegistration.cs

@@ -1,6 +1,9 @@
-
 namespace Clerk.BackendAPI.Hooks
 {
+    using System;
+    using System.Collections.Generic;
+    using Clerk.BackendAPI.Hooks.Telemetry;
+
     /// <summary>
     /// Hook Registration File.
     /// </summary>
@@ -28,10 +31,34 @@ public static void InitHooks(IHooks hooks)
             var clerkBeforeRequestHook = new ClerkBeforeRequestHook();
             hooks.RegisterBeforeRequestHook(clerkBeforeRequestHook);
 
-            // hooks.RegisterSDKInitHook(myHook);
-            // hooks.RegisterBeforeRequestHook(myHook);
-            // hooks.RegisterAfterSuccessHook(myHook);
-            // hooks.RegisterAfterErrorHook(myHook;
+            // Register telemetry hooks
+            RegisterTelemetryHooks(hooks);
+        }
+
+        /// <summary>
+        /// Registers telemetry hooks for collecting usage data.
+        /// </summary>
+        /// <param name="hooks">The hooks registry to add telemetry hooks to.</param>
+        private static void RegisterTelemetryHooks(IHooks hooks)
+        {
+
+            if (Environment.GetEnvironmentVariable("CLERK_TELEMETRY_DISABLED") == "1") {
+                return;
+            }
+
+            var telemetryCollectors = new List<ITelemetryCollector> { LiveTelemetryCollector.Standard() };
+            if (Environment.GetEnvironmentVariable("CLERK_TELEMETRY_DEBUG") == "1") {
+                telemetryCollectors.Add(new DebugTelemetryCollector());
+            }
+
+            var telemetryBeforeRequestHook = new TelemetryBeforeRequestHook(telemetryCollectors);
+            hooks.RegisterBeforeRequestHook(telemetryBeforeRequestHook);
+
+            var telemetryAfterSuccessHook = new TelemetryAfterSuccessHook(telemetryCollectors);
+            hooks.RegisterAfterSuccessHook(telemetryAfterSuccessHook);
+
+            var telemetryAfterErrorHook = new TelemetryAfterErrorHook(telemetryCollectors);
+            hooks.RegisterAfterErrorHook(telemetryAfterErrorHook);
         }
     }
 }

src/Clerk/BackendAPI/Hooks/Telemetry/PreparedEvent.cs

@@ -0,0 +1,42 @@
+namespace Clerk.BackendAPI.Hooks.Telemetry
+{
+    using System.Collections.Generic;
+
+    public class PreparedEvent
+    {
+        public string Event { get; }
+        public string It { get; }
+        public string Sdk { get; }
+        public string Sdkv { get; }
+        public string Sk { get; }
+        public Dictionary<string, string> Payload { get; }
+
+        public PreparedEvent(string @event, string it, string sdk, string sdkv, string sk, Dictionary<string, string> payload)
+        {
+            Event = @event;
+            It = it;
+            Sdk = sdk;
+            Sdkv = sdkv;
+            Sk = sk;
+            Payload = payload;
+        }
+
+        public SortedDictionary<string, string> Sanitize()
+        {
+            var sanitizedEvent = new SortedDictionary<string, string>
+            {
+                ["event"] = Event,
+                ["it"] = It,
+                ["sdk"] = Sdk,
+                ["sdkv"] = Sdkv
+            };
+
+            foreach (var item in Payload)
+            {
+                sanitizedEvent[item.Key] = item.Value;
+            }
+
+            return sanitizedEvent;
+        }
+    }
+}

src/Clerk/BackendAPI/Hooks/Telemetry/SdkInfo.cs

@@ -0,0 +1,50 @@
+namespace Clerk.BackendAPI.Hooks.Telemetry
+{
+    using System;
+    using System.IO;
+    using System.Reflection;
+    using System.Xml;
+
+    public class SdkInfo
+    {
+        public string Version { get; }
+        public string Name { get; }
+        public string GroupId { get; }
+
+        public SdkInfo(string version, string name, string groupId)
+        {
+            Version = version;
+            Name = name;
+            GroupId = groupId;
+        }
+
+        public override string ToString()
+        {
+            return $"{{\"version\":\"{Version}\",\"name\":\"{Name}\",\"groupId\":\"{GroupId}\"}}";
+        }
+
+        public static SdkInfo? LoadFromAssembly()
+        {
+            try
+            {
+                var assembly = Assembly.GetExecutingAssembly();
+                var assemblyName = assembly.GetName();
+
+                // Get the version from the assembly
+                var version = assemblyName.Version?.ToString() ?? "unknown";
+
+                // Get the name (without namespace)
+                var name = assemblyName.Name ?? "unknown";
+
+                // For .NET we'll use the first part of the namespace as groupId
+                var groupId = name.Contains('.') ? name.Substring(0, name.IndexOf('.')) : "C#";
+
+                return new SdkInfo(version, name, groupId);
+            }
+            catch
+            {
+                return null;
+            }
+        }
+    }
+}

src/Clerk/BackendAPI/Hooks/Telemetry/TelemetryAfterErrorHook.cs

@@ -0,0 +1,47 @@
+namespace Clerk.BackendAPI.Hooks.Telemetry
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Net.Http;
+    using System.Threading.Tasks;
+
+    public class TelemetryAfterErrorHook : IAfterErrorHook
+    {
+        // Visible for testing
+        public readonly List<ITelemetryCollector> Collectors;
+
+        public TelemetryAfterErrorHook(List<ITelemetryCollector> collectors)
+        {
+            Collectors = collectors;
+        }
+
+        public Task<(HttpResponseMessage?, Exception?)> AfterErrorAsync(AfterErrorContext context, HttpResponseMessage? response, Exception? error)
+        {
+            var additionalPayload = new Dictionary<string, string>();
+
+            if (response != null)
+            {
+                additionalPayload["status_code"] = ((int)response.StatusCode).ToString();
+            }
+
+            if (error != null)
+            {
+                additionalPayload["error_message"] = error.Message;
+            }
+
+            TelemetryEvent @event = TelemetryEvent.FromContext(
+                context,
+                TelemetryEvent.EVENT_METHOD_FAILED,
+                0.1f,
+                additionalPayload
+            );
+
+            foreach (var collector in Collectors)
+            {
+                collector.Collect(@event);
+            }
+
+            return Task.FromResult((response, error));
+        }
+    }
+}

src/Clerk/BackendAPI/Hooks/Telemetry/TelemetryAfterSuccessHook.cs

@@ -0,0 +1,39 @@
+namespace Clerk.BackendAPI.Hooks.Telemetry
+{
+    using System.Collections.Generic;
+    using System.Net.Http;
+    using System.Threading.Tasks;
+
+    public class TelemetryAfterSuccessHook : IAfterSuccessHook
+    {
+        // Visible for testing
+        public readonly List<ITelemetryCollector> Collectors;
+
+        public TelemetryAfterSuccessHook(List<ITelemetryCollector> collectors)
+        {
+            Collectors = collectors;
+        }
+
+        public Task<HttpResponseMessage> AfterSuccessAsync(AfterSuccessContext context, HttpResponseMessage response)
+        {
+            var additionalPayload = new Dictionary<string, string>
+            {
+                ["status_code"] = ((int)response.StatusCode).ToString()
+            };
+
+            TelemetryEvent @event = TelemetryEvent.FromContext(
+                context,
+                TelemetryEvent.EVENT_METHOD_SUCCEEDED,
+                0.1f,
+                additionalPayload
+            );
+
+            foreach (var collector in Collectors)
+            {
+                collector.Collect(@event);
+            }
+
+            return Task.FromResult(response);
+        }
+    }
+}

src/Clerk/BackendAPI/Hooks/Telemetry/TelemetryBeforeRequestHook.cs

@@ -0,0 +1,35 @@
+namespace Clerk.BackendAPI.Hooks.Telemetry
+{
+    using System;
+    using System.Collections.Generic;
+    using System.Net.Http;
+    using System.Threading.Tasks;
+
+    public class TelemetryBeforeRequestHook : IBeforeRequestHook
+    {
+        // Visible for testing
+        public readonly List<ITelemetryCollector> Collectors;
+
+        public TelemetryBeforeRequestHook(List<ITelemetryCollector> collectors)
+        {
+            Collectors = collectors;
+        }
+
+        public Task<HttpRequestMessage> BeforeRequestAsync(BeforeRequestContext context, HttpRequestMessage request)
+        {
+            TelemetryEvent @event = TelemetryEvent.FromContext(
+                context,
+                TelemetryEvent.EVENT_METHOD_CALLED,
+                0.1f,
+                new Dictionary<string, string>()
+            );
+
+            foreach (var collector in Collectors)
+            {
+                collector.Collect(@event);
+            }
+
+            return Task.FromResult(request);
+        }
+    }
+}