elsa-core/specs/003-live-server-logs/data-model.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

56 lines
1.8 KiB
Markdown

# Data Model: Live Server Log Streaming
## ServerLogEvent
- `Id`: provider-scoped event identifier.
- `Sequence`: monotonic sequence when the provider can assign one.
- `Timestamp`: event timestamp in UTC.
- `ReceivedAt`: server/provider receive timestamp in UTC.
- `Level`: trace, debug, information, warning, error, critical.
- `Category`: logger category.
- `EventId`: numeric/name pair when provided by `ILogger`.
- `Message`: rendered redacted message.
- `MessageTemplate`: optional redacted template.
- `Exception`: optional redacted exception summary/detail.
- `Scopes`: redacted scope values.
- `Properties`: redacted structured log properties.
- `TraceId`, `SpanId`, `CorrelationId`: trace and request correlation.
- `TenantId`, `WorkflowDefinitionId`, `WorkflowInstanceId`: Elsa context when present.
- `SourceId`: foreign key to `ServerLogSource`.
## ServerLogSource
- `Id`: stable source identifier.
- `DisplayName`: user-readable process or pod name.
- `ServiceName`: logical service name, for example `elsa-server`.
- `MachineName`: host machine name.
- `ProcessId`: process identifier when available.
- `PodName`, `Namespace`, `ContainerName`, `NodeName`: Kubernetes/container metadata when available.
- `StartedAt`: source start time when known.
- `LastSeen`: last event or heartbeat timestamp.
- `Status`: connected, stale, disconnected, unknown.
## ServerLogFilter
- `MinimumLevel`
- `Levels`
- `CategoryPrefix`
- `Text`
- `TenantId`
- `WorkflowDefinitionId`
- `WorkflowInstanceId`
- `TraceId`
- `CorrelationId`
- `SourceId`
- `From`
- `To`
- `Take`
## Invariants
- Events exposed to callers are always redacted.
- Buffer size is bounded by configuration.
- Every event has a source ID.
- Recent query `Take` is capped server-side.
- Source status is derived from provider state and `LastSeen`.