Add request telemetry (#434)

nick-saxelby-cko · web-flow · commit bd28db6e435d · 2024-10-23T11:44:18.000+02:00
* Add recording of telemetry to ApiClient

* Allow reading of RecordTelemetry from .json config

* Formatting

* Add test to confirm configuring RecordTelemetry

* Readonly CodeQL fixes

* Readme spelling mistakes

* Change constant variables to const
diff --git a/README.md b/README.md
@@ -240,6 +240,29 @@ The execution of integration tests require the following environment variables s
 * For Default account systems (OAuth): `CHECKOUT_DEFAULT_OAUTH_CLIENT_ID` & `CHECKOUT_DEFAULT_OAUTH_CLIENT_SECRET`
 * For Previous account systems (ABC): `CHECKOUT_PREVIOUS_PUBLIC_KEY` & `CHECKOUT_PREVIOUS_SECRET_KEY`
 
+## Telemetry
+Request telemetry is enabled by default in the .NET SDK. Request latency is included in the telemetry data. Recording the request latency allows Checkout.com to continuously monitor and improve the merchant experience.
+
+Request telemetry can be disabled by opting out during CheckoutSdk builder step:
+```
+ICheckoutApi api = CheckoutSdk.Builder().StaticKeys()
+    .SecretKey("secret_key")
+    .RecordTelemetry(false)
+    .Environment(Environment.Sandbox)
+    .Build();
+```
+
+Or when using `CheckoutSDK.Extensions.Microsoft`:
+```
+{
+  "Checkout": {
+    ...
+    "RecordTelemetry": false,
+    ...
+  }
+}
+```
+
 ## Code of Conduct
 
 Please refer to [Code of Conduct](CODE_OF_CONDUCT.md)
diff --git a/src/CheckoutSdk.Extensions/CheckoutOptions.cs b/src/CheckoutSdk.Extensions/CheckoutOptions.cs
@@ -23,6 +23,7 @@ public class CheckoutOptions
         public PlatformType? PlatformType { get; set; }
 
         public IHttpClientFactory HttpClientFactory { get; set; }
-        
+
+        public bool RecordTelemetry { get; set; } = true;
     }
 }
diff --git a/src/CheckoutSdk.Extensions/CheckoutServiceCollection.cs b/src/CheckoutSdk.Extensions/CheckoutServiceCollection.cs
@@ -135,6 +135,7 @@ private static void SetCommonAttributes<TB, TC>(
             {
                 builder.HttpClientFactory(httpClientFactory);
             }
+            builder.RecordTelemetry(options.RecordTelemetry);
         }
     }
 }
diff --git a/src/CheckoutSdk/AbstractCheckoutSdkBuilder.cs b/src/CheckoutSdk/AbstractCheckoutSdkBuilder.cs
@@ -9,6 +9,8 @@ namespace Checkout
     public abstract class AbstractCheckoutSdkBuilder<T>
     {
         protected Environment Env = Checkout.Environment.Sandbox;
+
+        private bool _recordTelemetry = true;
         private EnvironmentSubdomain _envSubdomain;
         protected IHttpClientFactory ClientFactory = new DefaultHttpClientFactory();
 
@@ -24,6 +26,12 @@ public AbstractCheckoutSdkBuilder<T> EnvironmentSubdomain(string subdomain)
             return this;
         }
 
+        public AbstractCheckoutSdkBuilder<T> RecordTelemetry(bool recordTelemetry)
+        {
+            _recordTelemetry = recordTelemetry;
+            return this;
+        }
+
 #if (NETSTANDARD2_0_OR_GREATER || NETCOREAPP3_1_OR_GREATER)
         public AbstractCheckoutSdkBuilder<T> LogProvider(ILoggerFactory loggerFactory)
         {
@@ -40,7 +48,7 @@ public AbstractCheckoutSdkBuilder<T> HttpClientFactory(IHttpClientFactory httpCl
 
         protected CheckoutConfiguration GetCheckoutConfiguration()
         {
-            return new CheckoutConfiguration(GetSdkCredentials(), Env, _envSubdomain, ClientFactory);
+            return new CheckoutConfiguration(GetSdkCredentials(), Env, _envSubdomain, ClientFactory, _recordTelemetry);
         }
 
         protected abstract SdkCredentials GetSdkCredentials();
diff --git a/src/CheckoutSdk/ApiClient.cs b/src/CheckoutSdk/ApiClient.cs
@@ -3,7 +3,9 @@
 using System.Web;
 #endif
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Diagnostics;
 using System.Linq;
 using System.Net;
 using System.Net.Http;
@@ -19,16 +21,21 @@ public class ApiClient : IApiClient
         private readonly ILogger _log = LogProvider.GetLogger(typeof(ApiClient));
 #endif
 
+        private const string sdkTelemetryHeader = "cko-sdk-telemetry";
+        private const int maxCountInTelemetryQueue = 10;
         private readonly HttpClient _httpClient;
         private readonly Uri _baseUri;
         private readonly ISerializer _serializer = new JsonSerializer();
+        private readonly ConcurrentQueue<RequestMetrics> requestMetricsQueue = new ConcurrentQueue<RequestMetrics>();
+        private readonly bool _enableTelemetry;
 
-        public ApiClient(IHttpClientFactory httpClientFactory, Uri baseUri)
+        public ApiClient(IHttpClientFactory httpClientFactory, Uri baseUri, bool enableTelemetry)
         {
             CheckoutUtils.ValidateParams("httpClientFactory", httpClientFactory, "baseUri", baseUri);
             var httpClient = httpClientFactory.CreateClient();
             _baseUri = baseUri;
             _httpClient = httpClient;
+            _enableTelemetry = enableTelemetry;
         }
 
         public async Task<TResult> Get<TResult>(
@@ -170,7 +177,7 @@ public async Task<TResult> Query<TResult>(
                             $"{WebUtility.UrlEncode(kvp.Key)}={WebUtility.UrlEncode(kvp.Value)}"));
 #endif
 
-                            path = $"{path}?{queryString}";
+                    path = $"{path}?{queryString}";
                 }
             }
 
@@ -246,8 +253,37 @@ private async Task<HttpResponseMessage> Invoke(
             {
                 httpRequest.Headers.Add("Cko-Idempotency-Key", idempotencyKey);
             }
+            
+            if (_enableTelemetry)
+            {
+                var currentRequestId = Guid.NewGuid().ToString();
+                if (requestMetricsQueue.TryDequeue(out var lastRequestMetric))
+                {
+                    lastRequestMetric.RequestId = currentRequestId;
+                    httpRequest.Headers.TryAddWithoutValidation(sdkTelemetryHeader, _serializer.Serialize(lastRequestMetric));
+                }
 
-            return await _httpClient.SendAsync(httpRequest, cancellationToken);
+                Stopwatch stopwatch = new Stopwatch();
+                stopwatch.Start();
+                var result = await _httpClient.SendAsync(httpRequest, cancellationToken);
+                stopwatch.Stop();
+
+                if (requestMetricsQueue.Count < maxCountInTelemetryQueue)
+                {
+                    lastRequestMetric.PrevRequestDuration = stopwatch.ElapsedMilliseconds;
+                    requestMetricsQueue.Enqueue(new RequestMetrics()
+                    {
+                        PrevRequestDuration = stopwatch.ElapsedMilliseconds,
+                        PrevRequestId = currentRequestId
+                    });
+                }
+
+                return result;
+            }
+            else
+            {
+                return await _httpClient.SendAsync(httpRequest, cancellationToken);
+            }
         }
 
         private async Task ValidateResponseAsync(HttpResponseMessage httpResponse)
diff --git a/src/CheckoutSdk/CheckoutApi.cs b/src/CheckoutSdk/CheckoutApi.cs
@@ -79,25 +79,29 @@ private static ApiClient BaseApiClient(CheckoutConfiguration configuration)
             return new ApiClient(configuration.HttpClientFactory,
                 configuration.EnvironmentSubdomain != null
                     ? configuration.EnvironmentSubdomain.ApiUri
-                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri);
+                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri,
+                    configuration.RecordTelemetry);
         }
 
         private static ApiClient FilesApiClient(CheckoutConfiguration configuration)
         {
             return new ApiClient(configuration.HttpClientFactory,
-                configuration.Environment.GetAttribute<EnvironmentAttribute>().FilesApiUri);
+                configuration.Environment.GetAttribute<EnvironmentAttribute>().FilesApiUri,
+                configuration.RecordTelemetry);
         }
 
         private static ApiClient TransfersApiClient(CheckoutConfiguration configuration)
         {
             return new ApiClient(configuration.HttpClientFactory,
-                configuration.Environment.GetAttribute<EnvironmentAttribute>().TransfersApiUri);
+                configuration.Environment.GetAttribute<EnvironmentAttribute>().TransfersApiUri,
+                configuration.RecordTelemetry);
         }
 
         private static ApiClient BalancesApiClient(CheckoutConfiguration configuration)
         {
             return new ApiClient(configuration.HttpClientFactory,
-                configuration.Environment.GetAttribute<EnvironmentAttribute>().BalancesApiUri);
+                configuration.Environment.GetAttribute<EnvironmentAttribute>().BalancesApiUri,
+                configuration.RecordTelemetry);
         }
 
 
diff --git a/src/CheckoutSdk/CheckoutConfiguration.cs b/src/CheckoutSdk/CheckoutConfiguration.cs
@@ -10,6 +10,8 @@ public class CheckoutConfiguration
 
         public IHttpClientFactory HttpClientFactory { get; }
 
+        public bool RecordTelemetry { get; }
+
         public CheckoutConfiguration(
             SdkCredentials sdkCredentials,
             Environment environment,
@@ -28,7 +30,8 @@ public CheckoutConfiguration(
             SdkCredentials sdkCredentials,
             Environment environment,
             EnvironmentSubdomain environmentSubdomain,
-            IHttpClientFactory httpClientFactory)
+            IHttpClientFactory httpClientFactory,
+            bool recordTelemetry)
         {
             CheckoutUtils.ValidateParams(
                 "sdkCredentials", sdkCredentials, 
@@ -38,6 +41,7 @@ public CheckoutConfiguration(
             Environment = environment;
             EnvironmentSubdomain = environmentSubdomain;
             HttpClientFactory = httpClientFactory;
+            RecordTelemetry = recordTelemetry;
         }
     }
 }
diff --git a/src/CheckoutSdk/Previous/AbstractCheckoutApmApi.cs b/src/CheckoutSdk/Previous/AbstractCheckoutApmApi.cs
@@ -15,7 +15,8 @@ protected AbstractCheckoutApmApi(CheckoutConfiguration configuration)
             var apiClient = new ApiClient(configuration.HttpClientFactory,
                 configuration.EnvironmentSubdomain != null
                     ? configuration.EnvironmentSubdomain.ApiUri
-                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri);
+                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri,
+                    configuration.RecordTelemetry);
             _idealClient = new IdealClient(apiClient, configuration);
             _klarnaClient = new KlarnaClient(apiClient, configuration);
             _sepaClient = new SepaClient(apiClient, configuration);
diff --git a/src/CheckoutSdk/Previous/CheckoutApi.cs b/src/CheckoutSdk/Previous/CheckoutApi.cs
@@ -33,7 +33,8 @@ public CheckoutApi(CheckoutConfiguration configuration) : base(configuration)
             var apiClient = new ApiClient(configuration.HttpClientFactory,
                 configuration.EnvironmentSubdomain != null
                     ? configuration.EnvironmentSubdomain.ApiUri
-                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri);
+                    : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri,
+                    configuration.RecordTelemetry);
             _tokensClient = new TokensClient(apiClient, configuration);
             _customersClient = new CustomersClient(apiClient, configuration);
             _sourcesClient = new SourcesClient(apiClient, configuration);
diff --git a/src/CheckoutSdk/RequestMetrics.cs b/src/CheckoutSdk/RequestMetrics.cs
@@ -0,0 +1,9 @@
+namespace Checkout
+{
+    public struct RequestMetrics
+    {
+        public string PrevRequestId { get; set; }
+        public string RequestId { get; set; }
+        public long PrevRequestDuration { get; set; }
+    }
+}
diff --git a/test/CheckoutSdkTest/CheckoutApiTest.cs b/test/CheckoutSdkTest/CheckoutApiTest.cs
@@ -16,7 +16,7 @@ public void ShouldInstantiateAndRetrieveClientsPrevious()
             httpClientFactoryMock.Setup(mock => mock.CreateClient())
                 .Returns(new HttpClient());
             var checkoutConfiguration = new CheckoutConfiguration(sdkCredentialsMock.Object, Environment.Sandbox, null,
-                httpClientFactoryMock.Object);
+                httpClientFactoryMock.Object, false);
 
             //Act
             Previous.ICheckoutApi checkoutApi = new Previous.CheckoutApi(checkoutConfiguration);
@@ -48,7 +48,7 @@ public void ShouldInstantiateAndRetrieveClientsDefault()
             httpClientFactoryMock.Setup(mock => mock.CreateClient())
                 .Returns(new HttpClient());
             var checkoutConfiguration = new CheckoutConfiguration(sdkCredentialsMock.Object, Environment.Sandbox, null,
-                httpClientFactoryMock.Object);
+                httpClientFactoryMock.Object, false);
 
             //Act
             ICheckoutApi checkoutApi = new CheckoutApi(checkoutConfiguration);
diff --git a/test/CheckoutSdkTest/CheckoutConfigurationTest.cs b/test/CheckoutSdkTest/CheckoutConfigurationTest.cs
@@ -13,7 +13,7 @@ private void ShouldCreateConfiguration()
             var credentials = new StaticKeysSdkCredentials(ValidDefaultSk, ValidDefaultPk);
             var httpClientFactoryMock = new Mock<IHttpClientFactory>();
             var configuration =
-                new CheckoutConfiguration(credentials, Environment.Production, null, httpClientFactoryMock.Object);
+                new CheckoutConfiguration(credentials, Environment.Production, null, httpClientFactoryMock.Object, false);
             configuration.Environment.ShouldBe(Environment.Production);
             configuration.SdkCredentials.ShouldBeAssignableTo(typeof(StaticKeysSdkCredentials));
         }
@@ -30,7 +30,7 @@ public void ShouldCreateConfigurationWithSubdomain(string subdomain, string expe
             var httpClientFactoryMock = new Mock<IHttpClientFactory>();
             var environmentSubdomain = new EnvironmentSubdomain(Environment.Sandbox, subdomain);
             var configuration = new CheckoutConfiguration(credentials, Environment.Sandbox, environmentSubdomain,
-                httpClientFactoryMock.Object);
+                httpClientFactoryMock.Object, false);
 
             configuration.Environment.ShouldBe(Environment.Sandbox);
             configuration.EnvironmentSubdomain.ApiUri.ToString().ShouldBe(expectedUri);
@@ -50,7 +50,7 @@ public void ShouldCreateConfigurationWithBadSubdomain(string subdomain, string e
             var httpClientFactoryMock = new Mock<IHttpClientFactory>();
             var environmentSubdomain = new EnvironmentSubdomain(Environment.Sandbox, subdomain);
             var configuration = new CheckoutConfiguration(credentials, Environment.Sandbox, environmentSubdomain,
-                httpClientFactoryMock.Object);
+                httpClientFactoryMock.Object, false);
 
             configuration.Environment.ShouldBe(Environment.Sandbox);
             configuration.EnvironmentSubdomain.ApiUri.ToString().ShouldBe(expectedUri);
diff --git a/test/CheckoutSdkTest/CheckoutSdkTelemetryIntegrationTest.cs b/test/CheckoutSdkTest/CheckoutSdkTelemetryIntegrationTest.cs

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public class CheckoutOptions`
`23`	`23`	`public PlatformType? PlatformType { get; set; }`
`24`	`24`
`25`	`25`	`public IHttpClientFactory HttpClientFactory { get; set; }`
`26`		`-`
	`26`	`+`
	`27`	`+ public bool RecordTelemetry { get; set; } = true;`
`27`	`28`	`}`
`28`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -135,6 +135,7 @@ private static void SetCommonAttributes<TB, TC>(`
`135`	`135`	`{`
`136`	`136`	`builder.HttpClientFactory(httpClientFactory);`
`137`	`137`	`}`
	`138`	`+ builder.RecordTelemetry(options.RecordTelemetry);`
`138`	`139`	`}`
`139`	`140`	`}`
`140`	`141`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,8 @@ namespace Checkout`
`9`	`9`	`public abstract class AbstractCheckoutSdkBuilder<T>`
`10`	`10`	`{`
`11`	`11`	`protected Environment Env = Checkout.Environment.Sandbox;`
	`12`	`+`
	`13`	`+ private bool _recordTelemetry = true;`
`12`	`14`	`private EnvironmentSubdomain _envSubdomain;`
`13`	`15`	`protected IHttpClientFactory ClientFactory = new DefaultHttpClientFactory();`
`14`	`16`
`@@ -24,6 +26,12 @@ public AbstractCheckoutSdkBuilder<T> EnvironmentSubdomain(string subdomain)`
`24`	`26`	`return this;`
`25`	`27`	`}`
`26`	`28`
	`29`	`+ public AbstractCheckoutSdkBuilder<T> RecordTelemetry(bool recordTelemetry)`
	`30`	`+ {`
	`31`	`+ _recordTelemetry = recordTelemetry;`
	`32`	`+ return this;`
	`33`	`+ }`
	`34`	`+`
`27`	`35`	`#if (NETSTANDARD2_0_OR_GREATER \|\| NETCOREAPP3_1_OR_GREATER)`
`28`	`36`	`public AbstractCheckoutSdkBuilder<T> LogProvider(ILoggerFactory loggerFactory)`
`29`	`37`	`{`
`@@ -40,7 +48,7 @@ public AbstractCheckoutSdkBuilder<T> HttpClientFactory(IHttpClientFactory httpCl`
`40`	`48`
`41`	`49`	`protected CheckoutConfiguration GetCheckoutConfiguration()`
`42`	`50`	`{`
`43`		`- return new CheckoutConfiguration(GetSdkCredentials(), Env, _envSubdomain, ClientFactory);`
	`51`	`+ return new CheckoutConfiguration(GetSdkCredentials(), Env, _envSubdomain, ClientFactory, _recordTelemetry);`
`44`	`52`	`}`
`45`	`53`
`46`	`54`	`protected abstract SdkCredentials GetSdkCredentials();`
Original file line number	Diff line number	Diff line change
`@@ -79,25 +79,29 @@ private static ApiClient BaseApiClient(CheckoutConfiguration configuration)`
`79`	`79`	`return new ApiClient(configuration.HttpClientFactory,`
`80`	`80`	`configuration.EnvironmentSubdomain != null`
`81`	`81`	`? configuration.EnvironmentSubdomain.ApiUri`
`82`		`- : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri);`
	`82`	`+ : configuration.Environment.GetAttribute<EnvironmentAttribute>().ApiUri,`
	`83`	`+ configuration.RecordTelemetry);`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`private static ApiClient FilesApiClient(CheckoutConfiguration configuration)`
`86`	`87`	`{`
`87`	`88`	`return new ApiClient(configuration.HttpClientFactory,`
`88`		`- configuration.Environment.GetAttribute<EnvironmentAttribute>().FilesApiUri);`
	`89`	`+ configuration.Environment.GetAttribute<EnvironmentAttribute>().FilesApiUri,`
	`90`	`+ configuration.RecordTelemetry);`
`89`	`91`	`}`
`90`	`92`
`91`	`93`	`private static ApiClient TransfersApiClient(CheckoutConfiguration configuration)`
`92`	`94`	`{`
`93`	`95`	`return new ApiClient(configuration.HttpClientFactory,`
`94`		`- configuration.Environment.GetAttribute<EnvironmentAttribute>().TransfersApiUri);`
	`96`	`+ configuration.Environment.GetAttribute<EnvironmentAttribute>().TransfersApiUri,`
	`97`	`+ configuration.RecordTelemetry);`
`95`	`98`	`}`
`96`	`99`
`97`	`100`	`private static ApiClient BalancesApiClient(CheckoutConfiguration configuration)`
`98`	`101`	`{`
`99`	`102`	`return new ApiClient(configuration.HttpClientFactory,`
`100`		`- configuration.Environment.GetAttribute<EnvironmentAttribute>().BalancesApiUri);`
	`103`	`+ configuration.Environment.GetAttribute<EnvironmentAttribute>().BalancesApiUri,`
	`104`	`+ configuration.RecordTelemetry);`
`101`	`105`	`}`
`102`	`106`
`103`	`107`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ public class CheckoutConfiguration`
`10`	`10`
`11`	`11`	`public IHttpClientFactory HttpClientFactory { get; }`
`12`	`12`
	`13`	`+ public bool RecordTelemetry { get; }`
	`14`	`+`
`13`	`15`	`public CheckoutConfiguration(`
`14`	`16`	`SdkCredentials sdkCredentials,`
`15`	`17`	`Environment environment,`
`@@ -28,7 +30,8 @@ public CheckoutConfiguration(`
`28`	`30`	`SdkCredentials sdkCredentials,`
`29`	`31`	`Environment environment,`
`30`	`32`	`EnvironmentSubdomain environmentSubdomain,`
`31`		`- IHttpClientFactory httpClientFactory)`
	`33`	`+ IHttpClientFactory httpClientFactory,`
	`34`	`+ bool recordTelemetry)`
`32`	`35`	`{`
`33`	`36`	`CheckoutUtils.ValidateParams(`
`34`	`37`	`"sdkCredentials", sdkCredentials,`
`@@ -38,6 +41,7 @@ public CheckoutConfiguration(`
`38`	`41`	`Environment = environment;`
`39`	`42`	`EnvironmentSubdomain = environmentSubdomain;`
`40`	`43`	`HttpClientFactory = httpClientFactory;`
	`44`	`+ RecordTelemetry = recordTelemetry;`
`41`	`45`	`}`
`42`	`46`	`}`
`43`	`47`	`}`