Stratara.EventSourcing.Pipeline.CommandAudit
4.1.0
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.EventSourcing.Pipeline.CommandAudit --version 4.1.0
NuGet\Install-Package Stratara.EventSourcing.Pipeline.CommandAudit -Version 4.1.0
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="4.1.0" />
<PackageVersion Include="Stratara.EventSourcing.Pipeline.CommandAudit" Version="4.1.0" />
<PackageReference Include="Stratara.EventSourcing.Pipeline.CommandAudit" />
paket add Stratara.EventSourcing.Pipeline.CommandAudit --version 4.1.0
#r "nuget: Stratara.EventSourcing.Pipeline.CommandAudit, 4.1.0"
#:package Stratara.EventSourcing.Pipeline.CommandAudit@4.1.0
#addin nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=4.1.0
#tool nuget:?package=Stratara.EventSourcing.Pipeline.CommandAudit&version=4.1.0
Stratara.EventSourcing.Pipeline.CommandAudit
Derived. The behaviour described here is specified under
openspec/specs/. Those specifications are the source; this page explains and illustrates them.
License: MIT.
Mediator pipeline behavior that records an audit row for every dispatched command in the Stratara event-sourced stack. Both arities are provided so consumers can register a single behavior pair and have it apply to all command shapes.
What's in the box
| Type | Purpose |
|---|---|
AddCommandAuditing() |
The package's public surface — registers both behavior arities in one call. |
CommandAuditBehavior<TRequest> (internal) |
Runs the audit-write step before delegating to next() for IRequest (commands without result). |
CommandAuditBehavior<TRequest, TResult> (internal) |
Same, for IRequest<TResult> (commands with result + queries). Only records when the request also implements ICommandBase — queries flow through untouched. |
CommandAuditWriter (internal) |
Opens a transaction on IWriteUnitOfWork, writes via ICommandAuditRepository.AddAsync, commits. |
The behavior only audits commands — query requests reach the same generic interface but are filtered by the is ICommandBase check, so registering both behaviors application-wide is safe.
Quick start
// At composition time, alongside the other framework pipeline behaviors:
builder.Services.AddCommandAuditing();
That one call registers both behavior arities. The behavior types themselves are internal — they
are an implementation detail, not something to name from your composition root.
The behaviors resolve IWriteUnitOfWork from DI (ships with Stratara.EventSourcing.EntityFrameworkCore in the default deployment). No additional registration is needed.
Dependencies
Stratara.Abstractions— forIPipelineBehavior<,>,IRequest/IRequest<T>,ICommandBase,IWriteUnitOfWork,ICommandAuditRepository.JetBrains.Annotations—[UsedImplicitly]on the public behavior classes (DI-instantiated, no static call site).
At runtime an IWriteUnitOfWork implementation must be registered — typically by referencing Stratara.EventSourcing.EntityFrameworkCore and calling AddWriteStore(IConfiguration).
Security note — command payload contents
The audit row stores CommandTypeName and the serialized CommandJson of the dispatched command. Whatever fields your commands carry land in the audit table. Sensitive data (passwords, tokens, API keys, encryption material) MUST NOT live on a command record — or must be marked with [EncryptData] so the registered ISecureJsonSerializer encrypts them before persistence.
The default Stratara registration uses ISecureJsonSerializer (AES-GCM + tenant-scoped AAD) for the audit serialization, so [EncryptData]-annotated properties are protected. Plain-text properties go to disk unencrypted — treat the audit table accordingly when designing command shapes.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- JetBrains.Annotations (>= 2026.2.0)
- Stratara.Abstractions (>= 4.1.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 4.4.4 | 93 | 10/10/2026 |
| 4.4.3 | 79 | 10/10/2026 |
| 4.4.2 | 298 | 10/2/2026 |
| 4.4.1 | 347 | 9/29/2026 |
| 4.4.0 | 125 | 9/27/2026 |
| 4.3.1 | 121 | 9/25/2026 |
| 4.3.0 | 286 | 9/23/2026 |
| 4.2.0 | 129 | 9/18/2026 |
| 4.1.1 | 98 | 9/16/2026 |
| 4.1.0 | 97 | 9/16/2026 |
| 4.0.4 | 824 | 9/14/2026 |
| 4.0.3 | 110 | 9/3/2026 |
| 4.0.2 | 603 | 9/3/2026 |
| 4.0.1 | 329 | 9/2/2026 |
| 4.0.0 | 164 | 8/31/2026 |
| 4.0.0-preview.1 | 77 | 8/31/2026 |
| 3.4.0 | 146 | 8/28/2026 |
| 3.3.0 | 114 | 8/25/2026 |
| 3.2.3 | 113 | 8/22/2026 |
| 3.2.2 | 128 | 8/14/2026 |
The Orleans execution model ships as two new packages, `Stratara.Orleans` and
`Stratara.Orleans.EntityFrameworkCore`: one writer per aggregate across a cluster, accepted commands that
survive a crash, and projections and sagas that never miss a committed fact. Every host on the Entity
Framework store generates one migration when it upgrades, whether or not it adopts the execution model.
Telemetry type tags now carry the simple type name on every instrument, so a dashboard that filters the
projection, saga or conflict series on the qualified name needs its filter updated. Eight fixes land on
the retry, conflict, redaction and encryption work of 4.0.4, with one new warning to know about.
### Added
- **The Orleans execution model: `Stratara.Orleans` and `Stratara.Orleans.EntityFrameworkCore`.**
Commands, projections, sagas, durable timers and singleton work run as virtual actors on an Orleans
10.3 cluster. One aggregate has one writer across the deployment; a command the execution model's
dispatcher accepts is recorded before the call returns and resumed after a crash, a bounded number of
times, through the same mediator pipeline as on the bus; projections and sagas read the store in
commit order from a checkpoint, so a crash costs latency and never a committed fact; singleton work
runs once per cluster without a lock; a failing entry stops its partition and is retried instead of
being dropped. Handlers, projections and sagas are unchanged, each role is adopted with one
registration after its composite, and both models can run side by side during a rollout. Every
setting is validated at start. See *Choose an Execution Model*, *Migrate to the Orleans Execution
Model* and *Operate the Orleans Execution Model* on the documentation site.
- **Schema additions — every host on the Entity Framework store generates a migration.** The framework's
write context declares `event_stream_entry.partition_position`, the `partition_position` table, on
PostgreSQL `event_stream_entry.commit_transaction_id`, and the `outbox_entry` columns `aggregate_id`,
`heavy`, `attempt_count`, `last_handed_over_at`, `kept_at` and `last_failure`; the read context declares
`projection_checkpoint`. They are part of the model whether or not a host adopts the execution model, so
every host on `Stratara.EventSourcing.EntityFrameworkCore` generates and applies a migration after
upgrading — without it, appends and outbox writes fail on the missing columns. A store that never runs
the execution model carries them unfilled; on PostgreSQL an append also reads back the transaction id.
- **Composites without the bus-fed worker.** `AddEventProjectionServices()` and `AddSagaServices()`
register the projection and saga runtimes without their bus workers; `AddProjectionHandling` and
`AddSagaHandling` do the same on `IServiceCollection`.
- **Every instrument name is a published constant.** `ApplicationDiagnostics.Metrics` carries a
`…Name` constant beside each instrument — `EventsAppendedName`, `ProjectionEventsProcessedName`,
`SagasInFlightName` and the others — so a query or listener references the name instead of a literal.
`ApplicationDiagnostics.MetricTags.TypeNameValue` gives the value a type tag carries for a type name.
- `LogEvents.Messaging.WorkerQueueDeclaredWithOtherArguments` (`108_112`), the warning a RabbitMQ
worker logs when it uses an existing queue declared with other arguments.
### Changed
- **`event.type` and `aggregate.type` carry the simple type name on every instrument.** On
`projection.events.processed`, `saga.events.processed` and `event_source.append.conflicts` the tag
value changes from the assembly-qualified name (`Shop.Orders.OrderPlaced, Shop.Orders`) to the simple
name (`OrderPlaced`), the form `event_source.events.appended` already used, so write and read series
join on the same value. A dashboard or alert that filters those three series on the qualified name
needs its filter updated; no instrument or tag name changes.
- **`AddAuthorizingCommandOutboxDispatcher()` decorates whichever command dispatcher is registered**, not
only the RabbitMQ one, and composes with a dispatcher registered after it.
### Fixed
- **RabbitMQ: changing the retry bounds no longer stops a worker from subscribing.** A worker queue
carries `x-delivery-limit` from the bounds it was first declared with, and RabbitMQ refuses a
redeclaration with a different value — so a deployment that changed `MessageRetry` failed every
subscription with `PRECONDITION_FAILED`. An existing queue is now used as it is, and the bus logs
`108_112` naming it. From RabbitMQ 4.3 the old limit does not cut the new bounds short; before 4.3
a raised bound needs the drained queue deleted once.
- **Azure Service Bus: a subscription whose `MaxDeliveryCount` is below the bounds no longer hides
its dead-lettering.** Where the host can read the subscription, the bounds for it are lowered to
fit under the broker's limit, so the framework makes the move and it reaches `108_110` and
`messaging.dead_lettered`. The warning `108_111` now says so. A failure to read the subscription
of any kind other than cancellation ends the check instead of the subscription.
- **A unique violation is a concurrency conflict whatever exception type carries it.** The event
source consulted the registered `IStoreConflictDetector`s only for an Entity Framework
`DbUpdateException`, so a unit of work that surfaced the provider's exception unwrapped got a
persistence failure instead of a `ConcurrencyException`. Every detector now sees the exception
as the save threw it, as its contract says.
- **Proxy credentials and response cookies are redacted from traces in the form the semantic
conventions name them.** The HTTP client and ASP.NET Core enrichment callbacks replaced
`http.request.header.proxy_authorization` and `http.response.header.set_cookie`, but the
OpenTelemetry semantic conventions keep the dash — `proxy-authorization`, `set-cookie` — so a host
that captured headers under those names exported the values. Both forms are redacted now.
- **The concurrency-conflict policy retries a conflict the event source reports.** An append that
lost the race surfaces from `IEventSource.SaveChangesAsync` as `ConcurrencyException`, and
`ResilienceNames.ConcurrencyConflict` retried only `ConcurrencyConflictException` — so an
`IResilientRequest` whose handler appends events ran once and failed on the first conflict. The
policy now retries both, and still nothing else.
- **A revoked encrypted field of a value type reads as its default instead of failing the object.**
Deserialization wrote an unreadable field back as JSON `null`, which a `decimal`, `int` or other
non-nullable value type cannot hold — so erasing a subject's key made every record with such a
field throw instead of degrading. The field now reads as the type's default, and the object's
other fields are recovered.
- **`InMemoryKeyStore` keeps a scope usable after its current version is revoked.** Revoking the
current key left the scope pointing at a key that no longer existed, so the next
`GetOrCreateCurrentKeyAsync` threw. It now falls back to the highest remaining version, or creates
a new one, as `EnvelopeFileKeyStore` does.
- **`IAggregationService.AggregateAsync` no longer documents `fromVersion` as a start version.** The
parameter has never been honoured: a rebuild starts from the stream's beginning, or from the latest
snapshot at or below `toVersion`. Its documentation now says so; the signature is unchanged.