WorkflowForge.Extensions.Observability.OpenTelemetry 1.0.1

WorkflowForge.Extensions.Observability.OpenTelemetry

Advanced distributed tracing and observability extension for WorkflowForge using OpenTelemetry standards.

Installation

dotnet add package WorkflowForge.Extensions.Observability.OpenTelemetry

Quick Start

using WorkflowForge.Extensions.Observability.OpenTelemetry;

// Enable OpenTelemetry in foundry
var foundryConfig = FoundryConfiguration.ForProduction()
    .EnableOpenTelemetry("MyWorkflowService", "1.0.0");

var foundry = WorkflowForge.CreateFoundry("OrderProcessing", foundryConfig);

// Configure OpenTelemetry SDK in startup
builder.Services.AddOpenTelemetry()
    .WithTracing(tracing => tracing
        .AddSource("MyWorkflowService") // Match your service name
        .AddJaegerExporter()
        .AddConsoleExporter())
    .WithMetrics(metrics => metrics
        .AddMeter("MyWorkflowService") // Match your service name
        .AddPrometheusExporter());

Key Features

• Distributed Tracing: Full distributed tracing using OpenTelemetry Activity API
• Metrics Collection: Comprehensive metrics using System.Diagnostics.Metrics
• Foundry Integration: Deep integration with WorkflowForge foundries and operations
• Standard Protocols: OTLP, Jaeger, Zipkin, Prometheus compatibility
• High Performance: Built on .NET's native observability APIs

Distributed Tracing in Operations

public class OrderProcessingOperation : IWorkflowOperation
{
    public async Task<object?> ForgeAsync(object? inputData, IWorkflowFoundry foundry, CancellationToken cancellationToken)
    {
        // Start distributed tracing with context
        using var activity = foundry.StartActivity("ProcessOrder", ActivityKind.Server);
        
        var order = (Order)inputData!;
        
        // Add rich trace context
        activity?.SetTag("order.id", order.Id);
        activity?.SetTag("order.amount", order.Amount);
        activity?.SetTag("customer.id", order.CustomerId);
        
        try
        {
            var result = await ProcessOrderInternalAsync(order, cancellationToken);
            activity?.SetStatus(ActivityStatusCode.Ok);
            return result;
        }
        catch (Exception ex)
        {
            activity?.SetStatus(ActivityStatusCode.Error, ex.Message);
            throw;
        }
    }
}

Built-in Metrics

// Automatically collected operation metrics:
// - workflowforge.operations.total (counter)
// - workflowforge.operations.duration (histogram)
// - workflowforge.operations.errors.total (counter)
// - workflowforge.operations.active (updowncounter)

// System metrics:
// - workflowforge.process.memory.usage (gauge)
// - workflowforge.process.gc.collections.total (counter)
// - workflowforge.foundries.active (gauge)

Environment Configurations

// Development - verbose tracing
var devConfig = FoundryConfiguration.ForDevelopment()
    .EnableOpenTelemetry("MyService", "1.0.0", options =>
    {
        options.SampleRate = 1.0; // Trace everything
        options.EnableDetailedLogging = true;
    });

// Production - optimized performance
var prodConfig = FoundryConfiguration.ForProduction()
    .EnableOpenTelemetry("MyService", "1.0.0", options =>
    {
        options.SampleRate = 0.1; // Sample 10%
        options.EnableSystemMetrics = false;
    });

Examples & Documentation

• Complete Examples - Interactive OpenTelemetry samples
• Core Documentation - Core concepts
• Performance Extension - Performance monitoring
• Main README - Framework overview
• OpenTelemetry Documentation - OpenTelemetry official docs

Professional distributed observability for workflows