StatusNamaa

Easily integrate a lightweight metrics dashboard into your ASP.NET Core application. This package provides a simple yet effective way to monitor application status, accessible at /statusnamaa.svg.

Usage

1. In your Program.cs file Add app.AddStatusNamaa() and app.MapStatusNamaa():

   + builder.Services.AddStatusNamaa();
   
     var app = builder.Build();
   
   + app.MapStatusNamaa();

2. Add an image tag with statusnamaa.svg src in your HTML:

   <img src="/statusnamaa.svg" alt="StatusNamaa" />

Features

Customizing metrics

You can configure which metrics appear on the status page using StatusNamaaOptions:

builder.Services.AddStatusNamaa(o =>
{
    // Clear default metrics
    o.Metrics.Clear();

    // Add a .NET built-in metric
    o.AddMetric("dotnet.exceptions");

    // Add a .NET built-in metric with custom display name and type
    o.Metrics.Add(new StatusNamaaMetric
    {
        Name = "dotnet.process.memory.working_set",
        DisplayName = "Working Set",
        Type = StatusNamaaValueType.Bytes,
    });

    // Add a custom value
    o.AddMetric("Custom Value", async services =>
    {
        var listenerService = services.GetRequiredService<ListenerService>();

        return await listenerService.GetValue();
    });
});

Authentication

You can secure the status page by chaining RequireAuthorization() to the result of MapStatusNamaa():

app.MapStatusNamaa()
    .RequireAuthorization();

Metrics

Caching

You can cache the status page to reduce load on your application by adding CacheOutput() to the result of MapStatusNamaa():

app.MapStatusNamaa()
    .CacheOutput(options =>
    {
        options.Expire(TimeSpan.FromSeconds(10));
    });

More information about caching can be found in the Output caching docs.

Pre-release builds

Get the package from here.

Build

Install the required .NET SDK and run:

$ dotnet build