ObservaKit 1.0.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package ObservaKit --version 1.0.1
                    


                    

                
NuGet\Install-Package ObservaKit -Version 1.0.1
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="ObservaKit" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ObservaKit" Version="1.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ObservaKit" />
                    


                            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 ObservaKit --version 1.0.1
                    


                    

                
#r "nuget: ObservaKit, 1.0.1"
#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 ObservaKit@1.0.1
#: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=ObservaKit&version=1.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ObservaKit&version=1.0.1
                    


                            Install as a Cake Tool

ObservaKit

Full-stack observability for .NET services in 2 lines of code.

What's included

  • OpenTelemetry tracing + metrics with OTLP export
  • Prometheus metrics endpoint at /metrics
  • Serilog structured logging (Console, File, Grafana Loki)
  • Circuit-breaker health monitor for external service health tracking

Quick start

var builder = WebApplication.CreateBuilder(args);

builder.AddObservability();   // <-- registers everything

var app = builder.Build();

app.UseObservability();       // <-- maps /metrics endpoint

app.Run();

Configuration

Add to appsettings.json:

{
  "Observability": {
    "ServiceName": "my-api",
    "InstrumentationName": "MyApi",
    "OtlpEndpoint": "http://localhost:4317",
    "EnableSerilog": true,
    "EnableAspNetCoreInstrumentation": true,
    "AdditionalSources": [],
    "AdditionalMeters": []
  },
  "CircuitBreakerHealthMonitor": {
    "WindowSizeSeconds": 60,
    "FailureThreshold": 0.5,
    "MinimumRequests": 5
  }
}

All settings are optional. Sensible defaults are applied.

Health monitor

Track external service health with a sliding-window circuit breaker:

public class MyProcessor(IExternalServiceHealthMonitor health)
{
    public async Task ProcessAsync()
    {
        if (!health.IsHealthy("payment-gateway"))
        {
            // fallback or queue for retry
        }

        var sw = Stopwatch.StartNew();
        try
        {
            await CallExternalService();
            health.RecordSuccess("payment-gateway", sw.ElapsedMilliseconds);
        }
        catch
        {
            health.RecordFailure("payment-gateway", sw.ElapsedMilliseconds);
            throw;
        }
    }
}

Frameworks

  • .NET 8.0
  • .NET 9.0

License

MIT

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  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.1 99 4/13/2026
1.0.0 73 4/13/2026