chore: add OpenTelemetry support for metrics collection and export

thomasduft · thomasduft · commit cbce51bb5dd7 · 2025-05-10T21:00:32.000Z
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -90,7 +90,9 @@
         "-i",
         "../../samples/Definitions/commitquality",
         "-o",
-        "../../samples/Runs/commitquality"
+        "../../samples/Runs/commitquality",
+        "--otlp",
+        "http://localhost:9090/api/v1/otlp/v1/metrics"
       ],
       "cwd": "${workspaceFolder}/src/testr.Cli",
       "stopAtEntry": false
@@ -102,7 +104,11 @@
       "preLaunchTask": "build-testR",
       "program": "${workspaceFolder}/src/testr.Cli/bin/Debug/net9.0/tomware.TestR.dll",
       "args": [
-        "install-playwright"
+        "playwright",
+        "-c",
+        "install",
+        "-o",
+        "chromium"
       ],
       "cwd": "${workspaceFolder}/src/testr.Cli",
       "stopAtEntry": false
diff --git a/build/Targets.cs b/build/Targets.cs
@@ -187,4 +187,4 @@ static void CopyDirectory(string sourceDir, string destinationDir, bool recursiv
     }
   }
 }
-#endregion
+#endregion
diff --git a/docs/changelogs/636eeb1d56e749209e44b47b65638bd5.cle b/docs/changelogs/636eeb1d56e749209e44b47b65638bd5.cle
@@ -0,0 +1,9 @@
+{
+  "Id": "636eeb1d-56e7-4920-9e44-b47b65638bd5",
+  "IssueId": "",
+  "Prefix": "Added",
+  "Tag": "",
+  "Message": "Added support for OpenTelemetry.",
+  "CreatedAt": "2025-05-10T20:59:57.9498349+00:00",
+  "CreatedBy": "thomasduft"
+}
diff --git a/samples/Observability/docker-compose.yaml b/samples/Observability/docker-compose.yaml
@@ -16,6 +16,7 @@ services:
     container_name: prometheus
     command:
       - '--config.file=/etc/prometheus/prometheus.yml'
+      - '--web.enable-otlp-receiver'
     ports:
       - 9090:9090
     restart: unless-stopped
diff --git a/samples/Observability/prometheus/prometheus.yml b/samples/Observability/prometheus/prometheus.yml
@@ -1,19 +1,19 @@
 global:
-  scrape_interval: 15s
-  scrape_timeout: 10s
-  evaluation_interval: 15s
+  scrape_interval: 1s
+  scrape_timeout: 1s
+  evaluation_interval: 1s
 alerting:
   alertmanagers:
   - static_configs:
     - targets: []
     scheme: http
-    timeout: 10s
+    timeout: 1s
     api_version: v2
 scrape_configs:
 - job_name: prometheus
   honor_timestamps: true
-  scrape_interval: 15s
-  scrape_timeout: 10s
+  scrape_interval: 1s
+  scrape_timeout: 1s
   metrics_path: /metrics
   scheme: http
   static_configs:
diff --git a/samples/Runs/commitquality/TC-Documents-001.md b/samples/Runs/commitquality/TC-Documents-001.md
@@ -1,12 +1,12 @@
 # TC-Documents-001: Upload File
 
-- **Date**: 2025-03-26
+- **Date**: 2025-05-10
 - **Author**: Thomas Duft
 - **Test Priority**: High
 - **Module Name**: Documents
 - **Type**: Run
 - **Status**: Passed
-- **Domain**: https://commitquality.com
+- **Domain**: https://commitquality.com/
 - **Route**: practice-file-upload
 
 ## Description
diff --git a/samples/Runs/localhost/Dashboard/TC-Dashboard-100.md b/samples/Runs/localhost/Dashboard/TC-Dashboard-100.md
@@ -1,6 +1,6 @@
 # TC-Dashboard-100: Dashboard as administrator
 
-- **Date**: 2025-03-22
+- **Date**: 2025-05-10
 - **Test Priority**: High
 - **Module Name**: Dashboard
 - **Type**: Run
diff --git a/samples/Runs/localhost/TC-Login-001.md b/samples/Runs/localhost/TC-Login-001.md
@@ -1,6 +1,6 @@
 # TC-Login-001: Login
 
-- **Date**: 2025-03-22
+- **Date**: 2025-05-10
 - **Test Priority**: High
 - **Module Name**: Identity
 - **Type**: Run
diff --git a/samples/Runs/localhost/TC-Login-002.md b/samples/Runs/localhost/TC-Login-002.md
@@ -1,6 +1,6 @@
 # TC-Login-002: Login with wrong or not existing Username
 
-- **Date**: 2025-03-22
+- **Date**: 2025-05-10
 - **Test Priority**: High
 - **Module Name**: Identity
 - **Type**: Run
diff --git a/samples/Runs/localhost/TC-Login-003.md b/samples/Runs/localhost/TC-Login-003.md
@@ -1,6 +1,6 @@
 # TC-Login-003: Login with wrong Password
 
-- **Date**: 2025-03-22
+- **Date**: 2025-05-10
 - **Test Priority**: High
 - **Module Name**: Identity
 - **Type**: Run
diff --git a/samples/WebApi/Api/Workflows/Holiday/HolidayService.cs b/samples/WebApi/Api/Workflows/Holiday/HolidayService.cs
@@ -163,4 +163,4 @@ private async Task<Holiday> FindOrCreate(int? id)
       return holiday;
     }
   }
-}
+}
diff --git a/samples/WebApi/Common/MigrationService.cs b/samples/WebApi/Common/MigrationService.cs
@@ -189,4 +189,4 @@ string role
       await manager.AddToRoleAsync(applicationUser, role);
     }
   }
-}
+}
diff --git a/samples/WebApi/Pages/Login.cshtml.cs b/samples/WebApi/Pages/Login.cshtml.cs
@@ -104,4 +104,4 @@ public async Task<IActionResult> OnPostAsync(string returnUrl)
     // If we got this far, something failed, redisplay form
     return Page();
   }
-}
+}
diff --git a/src/testr.Cli/Commands/RunCommand.cs b/src/testr.Cli/Commands/RunCommand.cs
@@ -1,10 +1,19 @@
+using System.Diagnostics;
+using System.Diagnostics.Metrics;
 
 using McMaster.Extensions.CommandLineUtils;
 
 namespace tomware.TestR;
 
 public class RunCommand : CommandLineApplication
 {
+  private static readonly Meter TestCaseMeter
+    = new("tomware.TestR.Cli.Metrics");
+  private static readonly Counter<int> TestCaseCounter
+    = TestCaseMeter.CreateCounter<int>("testr_test_case");
+
+  private readonly Stopwatch _stopwatch = new();
+
   private readonly CommandArgument<string> _domain;
   private readonly CommandOption<string> _testCaseId;
   private readonly CommandOption<string> _inputDirectory;
@@ -138,6 +147,7 @@ private async Task<int> RunTestCaseAsync(
     CancellationToken cancellationToken
   )
   {
+    _stopwatch.Reset();
     var domain = _domain.ParsedValue;
 
     // Read the Test Case definition
@@ -171,13 +181,22 @@ CancellationToken cancellationToken
 
     ExecutorConfig executorConfig = GetExecutorConfiguration();
     var executor = new TestCaseExecutor(executorConfig);
+    _stopwatch.Start();
     var testStepResults = await executor.ExecuteAsync(
       domain,
       executionParam,
       preconditionExecutionParam,
       cancellationToken
     );
+    _stopwatch.Stop();
     var success = testStepResults.All(r => r.IsSuccess);
+
+    TestCaseCounter.Add(1, [
+      new("Duration", _stopwatch.ElapsedMilliseconds),
+      new("Status", success ? Constants.TestCaseStatus.Passed : Constants.TestCaseStatus.Failed),
+      new("TestCase", testCase.Id)
+    ]);
+
     if (!success)
     {
       foreach (var result in testStepResults.Where(r => !r.IsSuccess))
@@ -234,4 +253,4 @@ private ExecutorConfig GetExecutorConfiguration()
       _recordVideoDir.ParsedValue
     );
   }
-}
+}
diff --git a/src/testr.Cli/Commands/ValidateCommand.cs b/src/testr.Cli/Commands/ValidateCommand.cs
@@ -54,4 +54,4 @@ private async Task<int> ExecuteAsync(CancellationToken cancellationToken)
 
     return await Task.FromResult(0);
   }
-}
+}
diff --git a/src/testr.Cli/Domain/TestCaseExecutor.cs b/src/testr.Cli/Domain/TestCaseExecutor.cs
@@ -186,4 +186,4 @@ ILocator locator
 
     return Task.FromResult(true);
   }
-}
+}
diff --git a/src/testr.Cli/Domain/TestCaseValidator.cs b/src/testr.Cli/Domain/TestCaseValidator.cs
@@ -61,4 +61,4 @@ public TestCaseValidationResult Validate()
 
     return result;
   }
-}
+}
diff --git a/src/testr.Cli/Program.cs b/src/testr.Cli/Program.cs
@@ -15,12 +15,14 @@
 cli.Name = "testR";
 cli.Description = "A cli tool to manage and run executable test cases.";
 
+using var meterProvider = OtelHelper.CreateMeterProvider(ref args);
 using var cts = new CancellationTokenSource();
 Console.CancelKeyPress += (s, e) =>
 {
   Console.WriteLine("Cancelling...");
   cts.Cancel();
   e.Cancel = true;
 };
-
-return await cli.ExecuteAsync(args, cts.Token);
+var returnCode = await cli.ExecuteAsync(args, cts.Token);
+meterProvider.Dispose();
+return returnCode;
diff --git a/src/testr.Cli/Utils/OtelHelper.cs b/src/testr.Cli/Utils/OtelHelper.cs
@@ -0,0 +1,42 @@
+using OpenTelemetry;
+using OpenTelemetry.Exporter;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+
+internal static class OtelHelper
+{
+  private const string OtlpOption = "--otlp";
+
+  public static MeterProvider CreateMeterProvider(ref string[] args)
+  {
+    var meterProviderBuilder = Sdk.CreateMeterProviderBuilder()
+      .SetResourceBuilder(ResourceBuilder
+        .CreateDefault()
+        .AddService("testR.Cli"))
+      .AddMeter("tomware.TestR.Cli.Metrics");
+      // .AddConsoleExporter();
+    if (args.Contains(OtlpOption))
+    {
+      var otlpIndex = Array.IndexOf(args, OtlpOption);
+      if (otlpIndex + 1 < args.Length)
+      {
+        var uriString = args[otlpIndex + 1];
+        meterProviderBuilder
+          .AddOtlpExporter((exporterOptions, metricReaderOptions) =>
+          {
+            exporterOptions.Endpoint = new Uri(uriString);
+            exporterOptions.Protocol = OtlpExportProtocol.HttpProtobuf;
+            metricReaderOptions.PeriodicExportingMetricReaderOptions.ExportIntervalMilliseconds = 100;
+          });
+
+        // Remove the --otlp and the URI from the args
+        args = args
+          .Where((_, index) => index != otlpIndex && index != otlpIndex + 1)
+          .ToArray();
+      }
+    }
+    var meterProvider = meterProviderBuilder.Build();
+
+    return meterProvider;
+  }
+}
diff --git a/src/testr.Cli/testr.Cli.csproj b/src/testr.Cli/testr.Cli.csproj
@@ -43,6 +43,9 @@
     <PackageReference Include="McMaster.Extensions.CommandLineUtils" Version="4.1.1" />
     <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.4" />
     <PackageReference Include="Microsoft.Playwright" Version="1.52.0" />
+    <PackageReference Include="OpenTelemetry" Version="1.12.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.Console" Version="1.12.0" />
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.12.0" />
   </ItemGroup>
 
   <ItemGroup>
diff --git a/src/testr.Tests/TestCaseRunTests.cs b/src/testr.Tests/TestCaseRunTests.cs
@@ -59,4 +59,4 @@ public async Task SaveAsync_WithTestCaseDefinition_ShouldCreateFailedTestCaseRun
     Assert.Equal(Constants.TestCaseType.Run, testCaseRunExecution.Type);
     Assert.Equal(Constants.TestCaseStatus.Failed, testCaseRunExecution.Status);
   }
-}
+}
diff --git a/src/testr.Tests/TestCaseValidatorTests.cs b/src/testr.Tests/TestCaseValidatorTests.cs
@@ -96,4 +96,4 @@ public async Task Validate_WithWrongTestData_ShouldReturnOneValidationErrors()
     Assert.True(result.Errors.Count() == 1);
     Assert.Equal("Step 4: Requested value 'GetRole' was not found.", result.Errors.First());
   }
-}
+}

Original file line number	Diff line number	Diff line change
`@@ -187,4 +187,4 @@ static void CopyDirectory(string sourceDir, string destinationDir, bool recursiv`
`187`	`187`	`}`
`188`	`188`	`}`
`189`	`189`	`}`
`190`		`-#endregion`
	`190`	`+#endregion`