OpenSleigh.Reporting

ASP.NET Core Minimal API endpoints for monitoring and querying OpenSleigh saga state at runtime.

Installation

dotnet add package OpenSleigh.Reporting

Setup

Register reporting services and map endpoints in your Program.cs:

var builder = WebApplication.CreateBuilder(args);

builder.Services
    .AddOpenSleigh(cfg =>
    {
        // ... configure sagas and persistence ...
    })
    .AddOpenSleighReporting();

var app = builder.Build();

app.MapOpenSleighReporting(); // default prefix: /opensleigh

app.Run();

You can customise the route prefix:

app.MapOpenSleighReporting(prefix: "/api/sagas");

REST Endpoints

Query Parameters

The list endpoint (/opensleigh/sagas) supports:

Response Shape

List queries return a PagedResult<SagaInstanceInfo>:

{
  "items": [
    {
      "instanceId": "...",
      "correlationId": "...",
      "triggerMessageId": "...",
      "sagaType": "OrderSaga",
      "sagaStateType": "OrderSagaState",
      "isCompleted": false,
      "isLocked": false,
      "processedMessages": [
        { "messageId": "...", "when": "2025-01-15T10:30:00Z" }
      ],
      "stateData": { /* saga-specific state */ }
    }
  ],
  "totalCount": 42,
  "page": 1,
  "pageSize": 20
}

Security

⚠️ Warning: These endpoints expose saga state data, which may contain sensitive information. Add authentication and authorization middleware before calling MapOpenSleighReporting() in production environments.

app.MapOpenSleighReporting()
   .RequireAuthorization("AdminPolicy");

OpenAPI Support

On .NET 9+, AddOpenSleighReporting() automatically registers OpenAPI services and MapOpenSleighReporting() maps the OpenAPI document endpoint. You can browse the generated API description at /openapi/v1.json.

Documentation

For full documentation, samples, and configuration guides, see the OpenSleigh repository.