Stratara.ServiceDefaults
4.5.0
Prefix Reserved
See the version list below for details.
dotnet add package Stratara.ServiceDefaults --version 4.5.0
NuGet\Install-Package Stratara.ServiceDefaults -Version 4.5.0
<PackageReference Include="Stratara.ServiceDefaults" Version="4.5.0" />
<PackageVersion Include="Stratara.ServiceDefaults" Version="4.5.0" />
<PackageReference Include="Stratara.ServiceDefaults" />
paket add Stratara.ServiceDefaults --version 4.5.0
#r "nuget: Stratara.ServiceDefaults, 4.5.0"
#:package Stratara.ServiceDefaults@4.5.0
#addin nuget:?package=Stratara.ServiceDefaults&version=4.5.0
#tool nuget:?package=Stratara.ServiceDefaults&version=4.5.0
Stratara.ServiceDefaults
Derived. The behaviour described here is specified under
openspec/specs/. Those specifications are the source; this page explains and illustrates them.
License: MIT.
Cross-host observability defaults for the Stratara stack. Reference from every host (API, worker) to get OpenTelemetry + Serilog wired up with sensible defaults.
What's in the box
| Extension | Purpose |
|---|---|
ConfigureOpenTelemetry |
Logging + metrics + tracing with HTTP, EF Core, RabbitMQ, runtime instrumentation; OTLP exporter wired up automatically when OTEL_EXPORTER_OTLP_ENDPOINT is set. Accepts optional MeterProviderBuilder / TracerProviderBuilder callbacks for host-specific extras. |
ConfigureSerilog |
Structured logging with destructuring attributes, async console sink, OTLP sink (gRPC or HTTP/Protobuf based on OTEL_EXPORTER_OTLP_PROTOCOL), dev-mode log cleanup at {Path.GetTempPath()}/stratara-logs/{service-name}.log — the OS temp directory, so not literally /tmp on Windows or macOS. |
ConfigureSerilogBootstrapLogger |
Sets up Log.Logger as a bootstrap logger before the host is built, so early-startup errors surface to the console. |
Quick start
builder.ConfigureOpenTelemetry();
builder.ConfigureSerilog();
It deletes your development log file on start-up
In the Development environment only, configuring Serilog deletes the current log file before
opening it: %TEMP%/stratara-logs/{OTEL_SERVICE_NAME}.log, where the service name falls back to
Unknown when OTEL_SERVICE_NAME is unset. The intent is a clean file per debugging session rather
than one that grows across dozens of restarts.
Two consequences worth knowing before they cost you an hour:
- A crash you wanted to read is gone the moment you restart to reproduce it. Copy the file before restarting, or point the sink elsewhere for that session.
- Two development services with no
OTEL_SERVICE_NAMEshareUnknown.logand delete each other's. Set the variable per service.
Outside Development nothing is deleted.
Sibling packages
Stratara.EventSourcing.WorkerDefaults— one-stopAddBackendServices/AddXxxWorkerServicescomposites that wire the framework's mediator + outbox + projections + sagas stack.Stratara.ServiceDefaults.AspNetCore— ASP.NET-specific extras:AddDefaultHealthChecks+MapDefaultEndpoints(/health,/alive) and ASP.NET request OTel instrumentation.
Dependencies
Stratara.Shared— diagnostics base (ApplicationDiagnostics.Activity.SourceName).- OpenTelemetry runtime + exporter packages.
- Serilog sinks (Console, File, Async, OpenTelemetry).
Destructurama.Attributedfor destructuring conventions.Microsoft.Extensions.Http.Resilience+Microsoft.Extensions.ServiceDiscovery.
Prerelease dependencies. This package transitively pulls in two prerelease OpenTelemetry instrumentation packages that have no stable release yet:
OpenTelemetry.Instrumentation.EntityFrameworkCore(beta) andRabbitMQ.Client.OpenTelemetry(RC). Both ride the stable OpenTelemetry 1.15.x core. NU5104 is suppressed in this csproj with that justification — consumers inherit the prerelease deps transitively. We will swap to GA as soon as the vendors ship stable.
| 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
- Destructurama.Attributed (>= 5.3.0)
- Microsoft.Extensions.Http.Resilience (>= 10.11.0)
- Microsoft.Extensions.ServiceDiscovery (>= 10.11.0)
- OpenTelemetry.Exporter.OpenTelemetryProtocol (>= 1.20.1)
- OpenTelemetry.Extensions.Hosting (>= 1.20.1)
- OpenTelemetry.Instrumentation.EntityFrameworkCore (>= 1.20.1-beta.1)
- OpenTelemetry.Instrumentation.Http (>= 1.20.1)
- OpenTelemetry.Instrumentation.Runtime (>= 1.20.1)
- RabbitMQ.Client.OpenTelemetry (>= 1.0.0-rc.2)
- Serilog.Extensions.Hosting (>= 10.0.0)
- Serilog.Formatting.Compact (>= 3.0.0)
- Serilog.Settings.Configuration (>= 10.0.1)
- Serilog.Sinks.Async (>= 2.1.0)
- Serilog.Sinks.Console (>= 6.1.1)
- Serilog.Sinks.File (>= 7.0.0)
- Serilog.Sinks.OpenTelemetry (>= 4.2.0)
- Stratara.Shared (>= 4.5.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Stratara.ServiceDefaults:
| Package | Downloads |
|---|---|
|
Stratara.ServiceDefaults.AspNetCore
ASP.NET Core extensions on top of Stratara.ServiceDefaults — default health checks, /health and /alive endpoints, and ASP.NET request OpenTelemetry instrumentation. Reference from every API host. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 4.6.0 | 0 | 10/28/2026 |
| 4.5.0 | 0 | 10/28/2026 |
| 4.4.10 | 142 | 10/26/2026 |
| 4.4.9 | 67 | 10/26/2026 |
| 4.4.8 | 215 | 10/24/2026 |
| 4.4.7 | 82 | 10/23/2026 |
| 4.4.6 | 176 | 10/22/2026 |
| 4.4.5 | 245 | 10/14/2026 |
| 4.4.4 | 260 | 10/10/2026 |
| 4.4.3 | 91 | 10/10/2026 |
| 4.4.2 | 361 | 10/2/2026 |
| 4.4.1 | 343 | 9/29/2026 |
| 4.4.0 | 113 | 9/27/2026 |
| 4.3.1 | 109 | 9/25/2026 |
| 4.3.0 | 276 | 9/23/2026 |
| 4.2.0 | 129 | 9/18/2026 |
| 4.1.1 | 89 | 9/16/2026 |
| 4.1.0 | 83 | 9/16/2026 |
| 4.0.4 | 812 | 9/14/2026 |
| 4.0.3 | 96 | 9/3/2026 |
A release about reads that cost more the more the store holds. Loading an aggregate read its stream and its
snapshot through every partition of the store, so every command grew slower as the store grew. A write context
that applies `ApplyGlobalEntityConfiguration()` also lost the index on the event stream's sequence number, which
left the hashing worker, reading in sequence order and the store's head without an index. Every read of one stream
is now confined to its partition, and the write model declares the indexes it was missing, whichever key the
context gives the event stream. No public type or member changes, but the write context needs a migration, and a
write context that overrides `ConfigureConventions` without calling `base` is now refused at start-up.
**Upgrading:**
- **If your store holds events written before 3.0.0, check it first.** Releases before 3.0.0 worked out a
stream's partition with another formula, and the store now reads a stream only in the partition its id gives.
The composition guide (*A store written before 3.0.0*) gives a check that needs nothing but the database, and a
repair that moves the rows to their partition without touching the hash chain. A store that 3.0.0 or later wrote
from its start has nothing to check.
- **Generate an EF Core migration for your write context.** It adds up to three indexes and changes no table or
column: `ix_event_stream_entry_sequence_number` (unique, only where the event stream is not keyed by its sequence
number, which `ApplyGlobalEntityConfiguration()` makes it), `ix_event_stream_entry_unhashed_sequence_number`
(the entries whose hash is still null) and `ix_event_chain_anchor_sequence_number`. A host that does not migrate
fails at `Migrate()` on pending model changes, as with any schema addition.
- **If you declared these indexes yourself, remove your declarations first.** Under the same names and
definitions, the migration then leaves them as they are. A `(stream_id, version)` index you added to bridge the
stream reads is no longer needed and can be dropped.
- **On a large store, create the indexes without blocking writes.** The schema section of the composition guide
shows a migration that creates them with `CREATE INDEX CONCURRENTLY`.
- **A context that overrides `ConfigureConventions` calls `base.ConfigureConventions`.** `WriteDbContext<TContext>`
declares the sequence-number indexes there. A write context whose override does not call it is now refused when
its model is built, at start-up and in `dotnet ef` alike, with an `InvalidOperationException` that names the
context, so it never runs or migrates without the indexes. An override that was fine on 4.4 because the
method was empty there needs `base.ConfigureConventions(configurationBuilder);` now.
- **An entry or snapshot written outside the framework has to carry its stream's partition.** The store writes
each one with the partition its stream id gives it, through `BucketCalculator.GetBucketId`, and now reads one
stream only there. A row a host inserted itself under another partition, in a test fixture or an import, is no
longer found by the reads of its stream.
### Fixed
- **Loading an aggregate costs what its stream holds.** The reads of one stream (whether it exists, its first entry,
a range of versions, its current version) and of its snapshot conditioned on the stream id alone. The indexes that
serve them begin with the partition, so PostgreSQL before 18 walked the whole index for each of them, and a
command loads several. They now condition on the partition as well. On 300,000 events, reading a stream of three
went from 2,404 pages to 6.
- **The sequence number stays indexed under `ApplyGlobalEntityConfiguration()`.** That convention keys every entity
by `Id`, the event stream included, which dropped the key the framework had put on the sequence number. The
hashing worker's reads, reading the store in sequence order and the store's head then scanned the whole table on
every pass. The write model now declares a unique index on the sequence number wherever it is not the key.
- **The hashing worker reads only what is still unchained.** An index over the entries whose hash is null lets
each pass read the backlog and not the chained history before it. Its filter names the column your model maps the
hash to.
- **The latest anchor is found by index.** The hash chain's anchors are indexed by sequence number, so finding the
last one no longer sorts every anchor on every pass.