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.
47 lines
2.8 KiB
Markdown
47 lines
2.8 KiB
Markdown
# Research: Diagnostics Structured Logs
|
|
|
|
## Decision: Use a consistent breaking rename
|
|
|
|
**Rationale**: The module is unpublished feature work and the old `Elsa.ServerLogs` identity miscommunicates raw console capture. Renaming assemblies, namespaces, public contracts, features, routes, permissions, docs, and tests keeps Studio and host configuration aligned before release.
|
|
|
|
**Alternatives considered**:
|
|
|
|
- Keep compatibility shims: rejected because they would preserve confusing names before the first stable release.
|
|
- Rename only package/namespace: rejected because shell feature names, routes, permissions, and public types would still imply server console logs.
|
|
|
|
## Decision: Keep structured `ILogger` capture as the module boundary
|
|
|
|
**Rationale**: The existing implementation already captures semantic `ILogger` events with levels, categories, properties, exceptions, source metadata, buffering, and live streaming. This is distinct from future raw stdout/stderr capture.
|
|
|
|
**Alternatives considered**:
|
|
|
|
- Redirect `Console.Out`/`Console.Error`: rejected as a future diagnostics console logs module concern.
|
|
- Add OpenTelemetry explorer behavior now: rejected because this module should only expose trace/span correlation fields.
|
|
|
|
## Decision: Populate message templates from `{OriginalFormat}`
|
|
|
|
**Rationale**: Microsoft logging providers expose the original template through the structured state entry named `{OriginalFormat}`. Capturing it preserves semantic search and Studio rendering without changing how rendered messages are produced.
|
|
|
|
**Alternatives considered**:
|
|
|
|
- Treat `{OriginalFormat}` as a normal property: rejected because it duplicates data and pollutes structured properties.
|
|
- Infer templates from rendered messages: rejected because rendered messages lose placeholder names.
|
|
|
|
## Decision: Capture active scopes through `IExternalScopeProvider`
|
|
|
|
**Rationale**: `ILoggerProvider` can implement `ISupportExternalScope` and receive the shared external scope provider from logging infrastructure. This is the standard way to inspect nested active scopes without owning scope lifetimes.
|
|
|
|
**Alternatives considered**:
|
|
|
|
- Store scopes inside each logger's `BeginScope`: rejected because framework logging already coordinates external scopes and multiple providers.
|
|
- Skip scopes: rejected by the spec and weakens operational context.
|
|
|
|
## Decision: Preserve bounded in-memory provider and redaction order
|
|
|
|
**Rationale**: The current bounded recent buffer, per-subscriber backpressure accounting, redaction-before-publish flow, source registry, and recursion guard satisfy the safety requirements and should survive the rename.
|
|
|
|
**Alternatives considered**:
|
|
|
|
- Introduce durable storage: rejected as out of scope.
|
|
- Add a distributed provider now: rejected because external providers can implement the existing provider boundary later.
|