elsa-core/specs/003-live-server-logs/contracts/rest-api.md
Sipke Schoorstra ab3e46bbe2
[codex] Add live server log streaming diagnostics (#7438)
* Add live server logs Spec Kit plan

* Implement live server logs diagnostics module

* Add server log sources and redaction hardening

* Add diagnostics unit tests

* Harden server log hub subscriptions

* Secure server log hub permissions

* Validate server log filter updates

* Add diagnostics logger and source tests

* Add diagnostics integration test project

* Add multi-source diagnostics provider coverage

* Broadcast server log source changes

* Document diagnostics server log streaming

* Add diagnostics sample host wiring

* Record diagnostics validation results

* Address server log PR feedback

* Rename diagnostics module to server logs

* Add server logs shell feature

* Make server logs shell options bindable

* Accept read wildcard for server logs

* Align server logs authorization with API patterns

* Update CShells structure and logging levels, add diagnostics module

* Rename PostgreSql shell feature classes for consistency

* Switch from Sqlite to PostgreSQL for workflow and identity persistence, add QuartzPostgreSql configuration

* Refactor server logs into diagnostics structured logs (#7440)

* Specify diagnostics structured logs refactor

* docs: clarify structured logs spec

* docs: plan diagnostics structured logs

* docs: add diagnostics structured logs tasks

* refactor: rename server logs to diagnostics structured logs

* Refactor PostgreSql persistence features to use centralized entity model handler registration.

* Refactor EFCore persistence features to centralize entity model handler registration for MySql, Sqlite, and Oracle providers.

* Integrate structured logs by renaming server logs, adjusting appsettings, and updating project references.

* Switch from PostgreSQL to Sqlite for workflow and identity persistence, update appsettings configuration.
2026-05-11 00:08:52 +02:00

1.2 KiB

Contract: Server Logs REST API

All endpoints use the Elsa API route prefix and require read:server-logs.

List Recent Logs

GET /server-logs/recent

Query parameters:

  • minimumLevel
  • level
  • categoryPrefix
  • text
  • tenantId
  • workflowDefinitionId
  • workflowInstanceId
  • traceId
  • correlationId
  • sourceId
  • from
  • to
  • take

Response:

{
  "items": [
    {
      "id": "evt-1",
      "timestamp": "2026-05-06T10:00:00Z",
      "level": "Information",
      "category": "Elsa.Workflows.Runtime",
      "message": "Workflow instance started",
      "sourceId": "elsa-server-1"
    }
  ],
  "droppedEvents": 0
}

List Sources

GET /server-logs/sources

Response:

{
  "items": [
    {
      "id": "elsa-server-1",
      "displayName": "elsa-server-7fd9c8b9c4-a2k1",
      "serviceName": "elsa-server",
      "podName": "elsa-server-7fd9c8b9c4-a2k1",
      "containerName": "elsa-server",
      "namespace": "production",
      "status": "Connected",
      "lastSeen": "2026-05-06T10:00:02Z"
    }
  ]
}

Validation

  • take above the configured maximum is clamped or rejected consistently.
  • Unknown levels return validation errors.
  • Date filters are UTC-normalized.