Add OpenTelemetry Sample

Directory.Build.props

@@ -19,20 +19,20 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Temporalio" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.DiagnosticSource" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.Hosting" Version="1.1.2" />
-    <PackageReference Include="Temporalio.Extensions.OpenTelemetry" Version="1.1.2" />
+    <PackageReference Include="Temporalio" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.DiagnosticSource" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.Hosting" Version="1.2.0" />
+    <PackageReference Include="Temporalio.Extensions.OpenTelemetry" Version="1.2.0" />
     <!--
     Can also reference the SDK downloaded to a local directory:
     <ProjectReference Include="$(MSBuildThisFileDirectory)..\temporal-sdk-dotnet\src\Temporalio\Temporalio.csproj" />
     -->
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.Logging" Version="7.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="7.0.0" />
-    <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.4.33" PrivateAssets="all" />
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" Version="8.0.0" />
+    <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.10.48" PrivateAssets="all" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435" PrivateAssets="all" />
   </ItemGroup>
 </Project>

README.md

@@ -22,6 +22,7 @@ Prerequisites:
 * [Encryption](src/Encryption) - End-to-end encryption with Temporal payload codecs.
 * [Mutex](src/Mutex) - How to implement a mutex as a workflow. Demonstrates how to avoid race conditions or parallel mutually exclusive operations on the same resource.
 * [Polling](src/Polling) - Recommended implementation of an activity that needs to periodically poll an external resource waiting its successful completion.
+* [OpenTelemetry](src/OpenTelemetry) - Demonstrates how to set up OpenTelemetry tracing and metrics for both the client and worker.
 * [Saga](src/Saga) - Demonstrates how to implement a saga pattern.
 * [Schedules](src/Schedules) - How to schedule workflows to be run at specific times in the future.
 * [SignalsQueries](src/SignalsQueries) - A loyalty program using Signals and Queries.

TemporalioSamples.sln

@@ -51,9 +51,11 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TemporalioSamples.Mutex", "
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TemporalioSamples.Saga", "src\Saga\TemporalioSamples.Saga.csproj", "{B79F07F7-3429-4C58-84C3-08587F748B2D}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.WorkflowUpdate", "src\WorkflowUpdate\TemporalioSamples.WorkflowUpdate.csproj", "{B3DB7B8C-7BD3-4A53-A809-AB6279B1A630}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TemporalioSamples.WorkflowUpdate", "src\WorkflowUpdate\TemporalioSamples.WorkflowUpdate.csproj", "{B3DB7B8C-7BD3-4A53-A809-AB6279B1A630}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TemporalioSamples.ContextPropagation", "src\ContextPropagation\TemporalioSamples.ContextPropagation.csproj", "{7B797D20-485F-441D-8E71-AF7E315FA9CF}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TemporalioSamples.ContextPropagation", "src\ContextPropagation\TemporalioSamples.ContextPropagation.csproj", "{7B797D20-485F-441D-8E71-AF7E315FA9CF}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TemporalioSamples.OpenTelemetry", "src\OpenTelemetry\TemporalioSamples.OpenTelemetry.csproj", "{7F8C536E-7664-4A19-A153-C86209EC0BDF}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -149,6 +151,14 @@ Global
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{7F8C536E-7664-4A19-A153-C86209EC0BDF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{7F8C536E-7664-4A19-A153-C86209EC0BDF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{7F8C536E-7664-4A19-A153-C86209EC0BDF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{7F8C536E-7664-4A19-A153-C86209EC0BDF}.Release|Any CPU.Build.0 = Release|Any CPU
+		{CDFAD7B0-FC43-4ECD-9E36-1023322294C9}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{CDFAD7B0-FC43-4ECD-9E36-1023322294C9}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{CDFAD7B0-FC43-4ECD-9E36-1023322294C9}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{CDFAD7B0-FC43-4ECD-9E36-1023322294C9}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -178,5 +188,6 @@ Global
 		{B79F07F7-3429-4C58-84C3-08587F748B2D} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 		{B3DB7B8C-7BD3-4A53-A809-AB6279B1A630} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 		{7B797D20-485F-441D-8E71-AF7E315FA9CF} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
+		{7F8C536E-7664-4A19-A153-C86209EC0BDF} = {1A647B41-53D0-4638-AE5A-6630BAAE45FC}
 	EndGlobalSection
 EndGlobal

src/OpenTelemetry/Activities.cs

@@ -0,0 +1,14 @@
+using Microsoft.Extensions.Logging;
+using Temporalio.Activities;
+
+namespace TemporalioSamples.OpenTelemetry
+{
+    public static class Activities
+    {
+        [Activity]
+        public static void MyActivity(string input)
+        {
+            ActivityExecutionContext.Current.Logger.LogInformation("Executing activity for OpenTelemetry sample.");
+        }
+    }
+}

src/OpenTelemetry/MyWorkflow.workflow.cs

@@ -0,0 +1,23 @@
+namespace TemporalioSamples.OpenTelemetry;
+
+using Microsoft.Extensions.Logging;
+using Temporalio.Workflows;
+
+[Workflow]
+public class MyWorkflow
+{
+    [WorkflowRun]
+    public async Task<string> RunAsync()
+    {
+        Workflow.Logger.LogInformation("Running workflow {WorkflowId}.", Temporalio.Workflows.Workflow.Info.WorkflowId);
+
+        await Workflow.ExecuteActivityAsync(
+            () => Activities.MyActivity("input"),
+            new()
+            {
+                StartToCloseTimeout = TimeSpan.FromMinutes(5),
+            });
+
+        return "complete!";
+    }
+}

src/OpenTelemetry/Program.cs

@@ -0,0 +1,104 @@
+using System.Diagnostics.Metrics;
+using System.Reflection;
+using Microsoft.Extensions.Logging;
+using OpenTelemetry;
+using OpenTelemetry.Metrics;
+using OpenTelemetry.Resources;
+using OpenTelemetry.Trace;
+using Temporalio.Client;
+using Temporalio.Extensions.DiagnosticSource;
+using Temporalio.Extensions.OpenTelemetry;
+using Temporalio.Runtime;
+using Temporalio.Worker;
+using TemporalioSamples.OpenTelemetry;
+
+AssemblyName assemblyName = typeof(TemporalClient).Assembly.GetName();
+
+using var meter = new Meter(assemblyName.Name!, assemblyName.Version!.ToString());
+
+string instanceId = args.ElementAtOrDefault(0) ?? throw new ArgumentException("Must pass 'worker' or 'workflow' as the single argument");
+
+ResourceBuilder resourceBuilder = ResourceBuilder.
+    CreateDefault()
+    .AddService("TemporalioSamples.OpenTelemetry", serviceInstanceId: instanceId);
+
+using TracerProvider tracerProvider = Sdk.
+    CreateTracerProviderBuilder().
+    SetResourceBuilder(resourceBuilder).
+    AddSource(TracingInterceptor.ClientSource.Name, TracingInterceptor.WorkflowsSource.Name, TracingInterceptor.ActivitiesSource.Name).
+    AddOtlpExporter().
+    Build();
+
+using MeterProvider meterProvider = Sdk.
+    CreateMeterProviderBuilder().
+    SetResourceBuilder(resourceBuilder).
+    AddMeter(assemblyName.Name!).
+    AddOtlpExporter().
+    Build();
+
+// Create a client to localhost on default namespace
+var client = await TemporalClient.ConnectAsync(new("localhost:7233")
+{
+    LoggerFactory = LoggerFactory.Create(builder =>
+        builder.
+            AddSimpleConsole(options => options.TimestampFormat = "[HH:mm:ss] ").
+            SetMinimumLevel(LogLevel.Information)),
+    Interceptors = new[] { new TracingInterceptor() },
+    Runtime = new TemporalRuntime(new TemporalRuntimeOptions()
+    {
+        Telemetry = new TelemetryOptions()
+        {
+            Metrics = new MetricsOptions()
+            {
+                CustomMetricMeter = new CustomMetricMeter(meter),
+            },
+        },
+    }),
+});
+
+async Task RunWorkerAsync()
+{
+    // Cancellation token cancelled on ctrl+c
+    using var tokenSource = new CancellationTokenSource();
+    Console.CancelKeyPress += (_, eventArgs) =>
+    {
+        tokenSource.Cancel();
+        eventArgs.Cancel = true;
+    };
+
+    // Run worker until cancelled
+    Console.WriteLine("Running worker");
+    using var worker = new TemporalWorker(
+        client,
+        new TemporalWorkerOptions(taskQueue: "opentelemetry-sample").
+            AddWorkflow<MyWorkflow>().
+            AddActivity(Activities.MyActivity));
+    try
+    {
+        await worker.ExecuteAsync(tokenSource.Token);
+    }
+    catch (OperationCanceledException)
+    {
+        Console.WriteLine("Worker cancelled");
+    }
+}
+
+async Task ExecuteWorkflowAsync()
+{
+    Console.WriteLine("Executing workflow");
+    await client.ExecuteWorkflowAsync(
+        (MyWorkflow wf) => wf.RunAsync(),
+        new(id: "opentelemetry-sample-workflow-id", taskQueue: "opentelemetry-sample"));
+}
+
+switch (args.ElementAtOrDefault(0))
+{
+    case "worker":
+        await RunWorkerAsync();
+        break;
+    case "workflow":
+        await ExecuteWorkflowAsync();
+        break;
+    default:
+        throw new ArgumentException("Must pass 'worker' or 'workflow' as the single argument");
+}

src/OpenTelemetry/Properties/launchSettings.json

@@ -0,0 +1,12 @@
+{
+  "profiles": {
+    "Worker": {
+      "commandName": "Project",
+      "commandLineArgs": "worker"
+    },
+    "Workflow": {
+      "commandName": "Project",
+      "commandLineArgs": "workflow"
+    }
+  }
+}

src/OpenTelemetry/README.md

@@ -0,0 +1,41 @@
+# OpenTelemetry
+
+This sample shows how to configure OpenTelemetry to capture workflow traces and SDK metrics.
+
+To run, first see [README.md](../../README.md) for prerequisites.
+
+Then, run the following from this directory to start the .NET Aspire Dashboard which will collect telemetry. The dashboard UI is available at http://localhost:18888.
+
+    docker compose up
+
+Then, run the following from this directory in a separate terminal to start the worker:
+
+    dotnet run worker
+
+Then in another terminal, run the workflow from this directory:
+
+    dotnet run workflow
+
+The workflow will complete.
+
+## Traces
+
+Traces can be viewed at http://localhost:18888/traces.
+
+You can select either `worker` or `workflow` for traces; both should show the same trace. The workflow should appear and when clicked, may look something like:
+
+![Tracing Screenshot](tracing-screenshot.png)
+
+## Metrics
+
+Metrics can be viewed by clicking the metrics tab on the dashboard.
+
+Similar to traces, you can select either `worker` or `workflow`.
+
+`worker` will show the metrics emitted by the worker. It may look something like:
+
+![Worker Metrics Screenshot](worker-metrics-screenshot.png)
+
+`workflow` will show the metrics emitted by the client. It may look something like:
+
+![Client Metrics Screenshot](client-metrics-screenshot.png)

src/OpenTelemetry/TemporalioSamples.OpenTelemetry.csproj

@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="OpenTelemetry.Exporter.OpenTelemetryProtocol" Version="1.9.0" />
+  </ItemGroup>
+
+</Project>

src/OpenTelemetry/docker-compose.yaml

@@ -0,0 +1,8 @@
+services:
+  aspire-dashboard:
+    environment:
+      Dashboard__Frontend__AuthMode: Unsecured
+    image: mcr.microsoft.com/dotnet/aspire-dashboard:8.0
+    ports:
+      - 4317:18889
+      - 18888:18888