RuntimeLens.Dashboard 1.0.1

RuntimeLens.Dashboard

Embedded single-page Web UI dashboard and REST API suite for visualizing application trace hierarchies, Flame Graphs, system metrics, and diagnostic alerts in real time. Zero external CDN dependencies.

Target Frameworks

• .NET 8.0 | .NET 9.0 | .NET 10.0

Configuration Reference (DashboardOptions)

Configured via builder.Services.AddRuntimeLensDashboard(options => ...):

🔒 Scoped Protection Note: Basic Authentication applies exclusively to routes matching RoutePrefix (e.g. /runtimelens/*) and does not affect application API controllers.

REST API Endpoints Reference

Trace Query Parameters (GET /{prefix}/api/traces)

• query (string): Search term matching operation name, trace ID, category, tags, or exceptions.
• page (int, default 1): Target page index.
• pageSize (int, default 25): Items per page (bounded between 5 and 100).
• onlySlow (bool, default false): Filter only operations exceeding SlowRequestThresholdMs.
• sortBy (string, default "Date"): Sorting field ("Date", "Duration", "Memory").

Code Examples

1. Dashboard Registration with Basic Auth (Program.cs)

using RuntimeLens.AspNetCore.Extensions;
using RuntimeLens.Dashboard.Extensions;

var builder = WebApplication.CreateBuilder(args);

// 1. Add Core Telemetry Engine Services
builder.Services.AddRuntimeLens(options =>
{
    options.EnableDashboard = true; // Enable telemetry retention for dashboard
});

// 2. Add Dashboard Services & Options
builder.Services.AddRuntimeLensDashboard(options =>
{
    options.RoutePrefix = "/runtimelens";   // Dashboard URL path prefix (http://localhost:5000/runtimelens)
    options.DefaultLanguage = "en";         // Default UI language: "en". Supported languages: "en", "tr"
    options.DefaultTheme = "dark";          // Initial theme: "dark" or "light"
    options.UseUtcTimestamp = true;         // Display timestamps in UTC time

    // Enable Basic Auth protection for dashboard endpoints
    options.Authentication.Enabled = true;
    options.Authentication.Username = "admin";
    options.Authentication.Password = "SecretPassword123!";
});

var app = builder.Build();

app.UseRouting();
app.UseRuntimeLens();          // Telemetry middleware

// 3. Register Dashboard Middleware & UI Endpoints
app.UseRuntimeLensDashboard();

app.Run();

2. Binding Options via appsettings.json

{
  "RuntimeLens": {
    "Dashboard": {
      "RoutePrefix": "/runtimelens",
      "DefaultLanguage": "en",
      "DefaultTheme": "dark",
      "UseUtcTimestamp": true,
      "Authentication": {
        "Enabled": true,
        "Username": "admin",
        "Password": "SecretPassword123!"
      }
    }
  }
}

var builder = WebApplication.CreateBuilder(args);

// Bind DashboardOptions directly from configuration section
builder.Services.AddRuntimeLensDashboard(options =>
{
    builder.Configuration.GetSection("RuntimeLens:Dashboard").Bind(options);
});

var app = builder.Build();

app.UseRouting();
app.UseRuntimeLens();
app.UseRuntimeLensDashboard(); // Serve dashboard UI & REST APIs

app.Run();

Learn More

👉 RuntimeLens GitHub Repository