Sylin.Koan.Observability 1.0.23

dotnet add package Sylin.Koan.Observability --version 1.0.23
                    
NuGet\Install-Package Sylin.Koan.Observability -Version 1.0.23
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sylin.Koan.Observability" Version="1.0.23" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Sylin.Koan.Observability" Version="1.0.23" />
                    
Directory.Packages.props
<PackageReference Include="Sylin.Koan.Observability" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Sylin.Koan.Observability --version 1.0.23
                    
#r "nuget: Sylin.Koan.Observability, 1.0.23"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Sylin.Koan.Observability@1.0.23
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Sylin.Koan.Observability&version=1.0.23
                    
Install as a Cake Addin
#tool nuget:?package=Sylin.Koan.Observability&version=1.0.23
                    
Install as a Cake Tool

Sylin.Koan.Observability

Reference Sylin.Koan.Observability when a Koan application should expose its framework traces and metrics through OpenTelemetry.

Install

dotnet add package Sylin.Koan.Observability

The package composes through the application's existing AddKoan() call. The package reference is the activation decision.

Outside Production, the reference creates one OpenTelemetry trace and metric pipeline with sensible development defaults. In Production, configure an OTLP destination to activate it:

{
  "Koan": {
    "Observability": {
      "Traces": { "Enabled": true, "SampleRate": 0.1 },
      "Metrics": { "Enabled": true },
      "Otlp": {
        "Endpoint": "http://collector:4317"
      }
    }
  }
}

OTEL_EXPORTER_OTLP_ENDPOINT and OTEL_EXPORTER_OTLP_HEADERS are the equivalent environment variables. Headers apply to both trace and metric export and are never included in startup or composition facts.

Usage: observe Koan signals

  • every Koan.* ActivitySource and Meter, including instruments added by future Koan packages;
  • ASP.NET Core and HttpClient tracing;
  • .NET runtime metrics;
  • one resource identity derived from the host application and entry assembly;
  • optional OTLP trace and metric exporters;
  • startup and composition facts that explain activation, enabled signals, and exporter kind.

Use OpenTelemetry's standard builder for application sources, processors, readers, or another exporter. It composes into the same providers:

builder.Services
    .AddOpenTelemetry()
    .WithTracing(traces => traces.AddSource("Orders.*"));

builder.Services.AddKoan();

No Koan-specific source registry or exporter abstraction is required.

Configuration

Setting Default Effect
Koan:Observability:Enabled true Master switch. false creates no Koan-owned provider.
Koan:Observability:Traces:Enabled true Enables Koan, ASP.NET Core, and HttpClient tracing.
Koan:Observability:Traces:SampleRate 0.1 Parent-based ratio sampling from 0 through 1.
Koan:Observability:Metrics:Enabled true Enables Koan and runtime metric composition.
Koan:Observability:Otlp:Endpoint none Absolute HTTP(S) OTLP endpoint; required for package activation in Production.
Koan:Observability:Otlp:Headers none Optional OTLP header string applied to both exporters.

Invalid booleans, sample rates, or endpoints reject host composition and name the exact setting plus its correction.

Inspection and boundaries

The module boot report and shared composition facts state whether the package is active, which signals are enabled, and whether export is otlp or none. Core health and Web diagnostic primitives remain in Sylin.Koan.Core; this package owns only the optional OpenTelemetry SDK pipeline.

  • Production without an OTLP endpoint is deliberately inert, even when application code separately configures a standard custom exporter. Applications with that topology should own the complete standard OpenTelemetry pipeline.
  • Without an exporter or metric reader, development composition exports nothing; a standard reader/exporter can be added for local inspection or tests.
  • The package does not provide log export, collector/backend availability, delivery, retention, tail sampling, application-specific spans, tag redaction, or custom-cardinality limits.
  • Individual instrument owners remain responsible for safe values and bounded metric dimensions.

See TECHNICAL.md for the composition and failure contract and the Observability reference for the operator map.

Product 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
1.0.23 148 9/10/2026
1.0.22 104 9/10/2026
1.0.21 101 9/9/2026
1.0.20 99 9/9/2026
1.0.18 114 9/9/2026
1.0.16 110 9/5/2026
1.0.15 115 8/30/2026
1.0.14 105 8/30/2026
1.0.13 108 8/28/2026
1.0.12 102 8/28/2026
1.0.11 106 8/27/2026
1.0.9 128 8/25/2026
1.0.8 112 8/24/2026
1.0.6 108 8/23/2026
1.0.5 101 8/22/2026
1.0.3 117 8/20/2026
1.0.1 123 8/17/2026
1.0.0 136 8/14/2026
0.20.6 119 7/23/2026
0.20.4 129 7/22/2026
Loading failed