👁 Image
Dosaic.Hosting.WebHost 1.2.34

Dosaic.Hosting.WebHost

👁 Nuget
👁 Nuget

Dosaic.Hosting.WebHost is the core orchestration package for any Dosaic-based service. It wires together plugin discovery, dependency injection, middleware pipeline configuration, health checks, OpenTelemetry, structured logging, CORS, response compression, IP rate limiting, and endpoint routing — all driven by the plugin interfaces from Dosaic.Hosting.Abstractions.

This package is mandatory. Without it no plugins can be loaded or configured.

Installation

dotnet add package Dosaic.Hosting.Generator # required for AOT-compatible plugin discovery
dotnet add package Dosaic.Hosting.WebHost

Or as package references in your .csproj:

<PackageReference Include="Dosaic.Hosting.Generator" Version="" />
<PackageReference Include="Dosaic.Hosting.WebHost" Version="" />

Usage

Replace the content of Program.cs with:

using Dosaic.Hosting.WebHost;

PluginWebHostBuilder.RunDefault(Dosaic.Generated.DosaicPluginTypes.All);

DosaicPluginTypes.All is a Type[] emitted at compile time by Dosaic.Hosting.Generator — no runtime reflection scanning is required.

For advanced scenarios (e.g. integration testing) you can separate build from run:

using Dosaic.Hosting.WebHost;

var host = PluginWebHostBuilder.Create(Dosaic.Generated.DosaicPluginTypes.All, args).Build();
host.Run();

Features

Plugin Lifecycle

PluginWebHostBuilder.Build() executes the following phases in order:

1 — Host Configuration (HostConfigurator)

• Clears default configuration sources and rebuilds them in the defined loading order (see Configuration below)
• Configures Kestrel: listening URLs (host:urls), max request body size (host:maxRequestSize), server header suppression
• Bootstraps Serilog structured logging

2 — Service Configuration (ServiceConfigurator)

• Registers default services: JSON serialization, memory cache, datetime providers, forwarded headers
• Configures CORS, response compression, IP rate limiting
• Adds MVC controllers with YAML formatters and custom validation error responses
• Discovers and registers [Configuration(...)]-attributed classes from IConfiguration
• Registers health checks: built-in liveness checks + [HealthCheck]-attributed types + plugin-contributed checks
• Configures OpenTelemetry metrics, tracing, and logging
• Calls IPluginServiceConfiguration.ConfigureServices() on all discovered plugins (sorted by origin)

3 — App Build

WebApplicationBuilder.Build() finalises the DI container.

4 — Application Configuration (AppConfigurator)

• Enables forwarded headers, response compression, IP rate limiting, CORS, Prometheus endpoint, routing
• Registers [Middleware]-attributed types ordered by their Order property
• Calls IPluginApplicationConfiguration.ConfigureApplication() on all discovered plugins
• Maps health endpoints (/health/liveness, /health/readiness)
• Maps controllers
• Calls IPluginEndpointsConfiguration.ConfigureEndpoints() on all discovered plugins

5 — Instance Cleanup

TypeImplementationResolver.ClearInstances() disposes all plugin constructor instances created during build.

Plugin Sort Order

Configuration

Kestrel / Host

host:
 urls: "http://+:8080" # default; separate multiple URLs with ","
 maxRequestSize: 8388608 # default 8 MB

Environment variables (single _ maps to : hierarchy):

HOST_URLS=http://+:8080
HOST_MAXREQUESTSIZE=8388608

Configuration File Loading Order

Dosaic loads configuration in the following order (later sources override earlier ones):

1. appsettings.json
2. appsettings.yaml / appsettings.yml
3. appsettings.*.json
4. appsettings.*.yaml / appsettings.*.yml
5. appsettings.secrets.json / appsettings.secrets.yaml / appsettings.secrets.yml
6. appsettings.*.secrets.json / appsettings.*.secrets.yaml / appsettings.*.secrets.yml
7. Environment variables
8. Command-line arguments

Files are sorted by node count (number of .-separated segments) within each group. Secrets files always load after non-secrets files. Files whose names do not start with appsettings are ignored.

Additional Config Paths

You can load configuration files from additional directories. Those files are loaded before the main application directory.

Via environment variable:

HOST_ADDITIONALCONFIGPATHS=/path/to/configs,/another/path

Via command-line argument:

dotnet run --HOST:ADDITIONALCONFIGPATHS "/path/to/configs,/another/path"

• Subfolders are scanned recursively for appsettings.* files
• Supports .json, .yaml, .yml formats
• Non-existent paths raise a DirectoryNotFoundException

Environment Variable Mapping

Dosaic uses a custom provider that maps environment variable names to configuration keys by replacing _ with : (hierarchy separator). Double underscore __ is first collapsed to single _ before the mapping.

HOST_URLS -> host:urls
SERILOG_minimumLevel -> serilog:minimumLevel

Logging (Serilog)

serilog:
 minimumLevel: Information # Verbose | Debug | Information | Warning | Error | Fatal
 override:
 System: Error
 Microsoft: Error

Environment variables:

SERILOG_minimumLevel=Information
SERILOG_OVERRIDE_SYSTEM=Error
SERILOG_OVERRIDE_MICROSOFT=Error

CORS

CorsPolicy:
 origins:
 - "https://example.com"
 methods:
 - "GET"
 - "POST"
 headers:
 - "*"
 exposedHeaders:
 - "*"

If any of origins, methods, headers, or exposedHeaders are not specified, they default to ["*"].

IP Rate Limiting

ipRateLimiting:
 enableEndpointRateLimiting: true
 generalRules:
 - endpoint: "*"
 period: "1s"
 limit: 50

ipRateLimitPolicies: {}

Refer to AspNetCoreRateLimit documentation for the full schema.

OpenTelemetry

When telemetry:endpoint is configured, traces, metrics, and logs are exported via OTLP. Log messages are enriched with SpanId and TraceId. Use telemetry:name to explicitly set the service name used by OpenTelemetry resources for traces, metrics, and logs.

telemetry:
 name: Dosaic.Example.Service # optional OpenTelemetry service name
 endpoint: http://localhost:4317 # OTLP endpoint
 protocol: grpc # grpc | http/protobuf
 headers:
 - name: Authorization
 value: "Bearer <token>"

Without telemetry:endpoint, only the Prometheus scraping endpoint (/metrics) is active.

Metrics instrumentation (always active):

• ASP.NET Core request metrics
• HTTP client metrics
• .NET runtime metrics
• Process metrics
• All custom Meters (*) plus the shared Dosaic meter (Tracing.SourceName)

Tracing instrumentation (requires telemetry:endpoint):

• ASP.NET Core (Swagger paths excluded)
• HTTP client
• The shared Dosaic ActivitySource (Tracing.SourceName) — emit your own spans with Tracing.StartActivity(...); see
• B3 propagation (single and multi-header)

Health Endpoints

Both endpoints return a JSON body:

{
 "status": "Healthy",
 "totalDuration": "00:00:00.012",
 "entries": [
 {
 "name": "api",
 "status": "Healthy",
 "description": null,
 "tags": ["liveness"],
 "duration": "00:00:00.001",
 "exceptionMessage": null
 }
 ]
}

Built-in liveness checks registered automatically:

Plugins can contribute additional checks via IPluginHealthChecksConfiguration.ConfigureHealthChecks(). Custom checks can also be auto-discovered by implementing IHealthCheck and annotating the class with [HealthCheck("name", ...tags)].