ab3e46bbe2
* 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.
75 lines
1.8 KiB
Markdown
75 lines
1.8 KiB
Markdown
# REST API Contract: Diagnostics Structured Logs
|
|
|
|
All endpoints use the Elsa API route prefix and require `read:diagnostics:structured-logs`.
|
|
|
|
## Get Recent Structured Logs
|
|
|
|
`POST /diagnostics/structured-logs/recent`
|
|
|
|
Request body is `StructuredLogFilter`.
|
|
|
|
Response body is `RecentStructuredLogsResult`.
|
|
|
|
```json
|
|
{
|
|
"items": [
|
|
{
|
|
"id": "01h...",
|
|
"sequence": 42,
|
|
"timestamp": "2026-05-10T12:00:00Z",
|
|
"receivedAt": "2026-05-10T12:00:00Z",
|
|
"level": "Information",
|
|
"category": "Elsa.Workflows.Runtime",
|
|
"eventId": 1001,
|
|
"eventName": "WorkflowStarted",
|
|
"message": "Workflow order-123 started",
|
|
"messageTemplate": "Workflow {WorkflowInstanceId} started",
|
|
"exception": null,
|
|
"scopes": {
|
|
"TenantId": "tenant-a"
|
|
},
|
|
"properties": {
|
|
"WorkflowInstanceId": "order-123"
|
|
},
|
|
"traceId": "4bf92f3577b34da6a3ce929d0e0e4736",
|
|
"spanId": "00f067aa0ba902b7",
|
|
"correlationId": "corr-123",
|
|
"tenantId": "tenant-a",
|
|
"workflowDefinitionId": "orders",
|
|
"workflowInstanceId": "order-123",
|
|
"sourceId": "local"
|
|
}
|
|
],
|
|
"droppedCount": 0
|
|
}
|
|
```
|
|
|
|
## List Structured Log Sources
|
|
|
|
`GET /diagnostics/structured-logs/sources`
|
|
|
|
Response body is a collection of `StructuredLogSource`.
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "local",
|
|
"name": "elsa-server",
|
|
"machineName": "dev-machine",
|
|
"processId": 12345,
|
|
"processName": "Elsa.Server.Web",
|
|
"podName": null,
|
|
"namespace": null,
|
|
"containerName": null,
|
|
"nodeName": null,
|
|
"startedAt": "2026-05-10T11:59:00Z",
|
|
"lastSeen": "2026-05-10T12:00:00Z",
|
|
"status": "Healthy"
|
|
}
|
|
]
|
|
```
|
|
|
|
## Compatibility Boundary
|
|
|
|
The previous `/server-logs/*` route names are not part of this unpublished feature's final contract. This module does not capture direct stdout/stderr writes.
|