| | | 1 | | using ArturRios.Heimdall.WebApi.Retention; |
| | | 2 | | using OpenTelemetry.Metrics; |
| | | 3 | | using OpenTelemetry.Resources; |
| | | 4 | | |
| | | 5 | | namespace ArturRios.Heimdall.WebApi.Metrics; |
| | | 6 | | |
| | | 7 | | /// <summary> |
| | | 8 | | /// Registers the OpenTelemetry metrics pipeline and mounts its Prometheus scrape endpoint. Both |
| | | 9 | | /// halves live here rather than inline in <c>Startup</c> so the tests can build a host with |
| | | 10 | | /// exactly this wiring and prove which requests reach the exporter — <c>Startup</c> itself |
| | | 11 | | /// cannot be exercised on the metrics port, because the in-memory test server reports a local |
| | | 12 | | /// port of <c>0</c> for every request. |
| | | 13 | | /// </summary> |
| | | 14 | | public static class MetricsConfiguration |
| | | 15 | | { |
| | | 16 | | /// <summary>The <c>service.name</c> every series carries, so dashboards can tell this API apart.</summary> |
| | | 17 | | public const string ServiceName = "heimdall-api"; |
| | | 18 | | |
| | | 19 | | /// <summary> |
| | | 20 | | /// Meters that ship inside the runtime and the frameworks the API already uses, subscribed to by |
| | | 21 | | /// name. None of them costs a package: each is emitted whether or not anything listens, and |
| | | 22 | | /// naming it here is what makes the exporter collect it. |
| | | 23 | | /// </summary> |
| | | 24 | | /// <remarks> |
| | | 25 | | /// <list type="bullet"> |
| | | 26 | | /// <item> |
| | | 27 | | /// <c>System.Runtime</c> — GC, heap, thread pool, exceptions, CPU. Built into .NET 9 |
| | | 28 | | /// and later, which is what replaces the OpenTelemetry.Instrumentation.Runtime package. |
| | | 29 | | /// </item> |
| | | 30 | | /// <item> |
| | | 31 | | /// <c>Microsoft.AspNetCore.Server.Kestrel</c> — connections, queued requests, TLS |
| | | 32 | | /// handshakes. <c>AddAspNetCoreInstrumentation</c> subscribes to it as well; it is named |
| | | 33 | | /// again so removing that call would not quietly take the connection metrics with it. |
| | | 34 | | /// </item> |
| | | 35 | | /// <item> |
| | | 36 | | /// <c>Microsoft.EntityFrameworkCore</c> — active contexts, queries, SaveChanges and |
| | | 37 | | /// optimistic-concurrency failures (EF Core 9 and later). |
| | | 38 | | /// </item> |
| | | 39 | | /// <item> |
| | | 40 | | /// <c>Npgsql</c> — connection pool usage, command duration and failures: the first |
| | | 41 | | /// place a saturated or unreachable database shows. |
| | | 42 | | /// </item> |
| | | 43 | | /// <item> |
| | | 44 | | /// <c>ArturRios.Heimdall.ScheduledPasses</c> — this API's own: rows processed and the time |
| | | 45 | | /// of the last successful run, per scheduled pass (#214). |
| | | 46 | | /// </item> |
| | | 47 | | /// </list> |
| | | 48 | | /// </remarks> |
| | 2 | 49 | | private static readonly string[] BuiltInMeters = |
| | 2 | 50 | | [ |
| | 2 | 51 | | "System.Runtime", |
| | 2 | 52 | | "Microsoft.AspNetCore.Server.Kestrel", |
| | 2 | 53 | | "Microsoft.EntityFrameworkCore", |
| | 2 | 54 | | "Npgsql", |
| | 2 | 55 | | ScheduledPassMetrics.MeterName |
| | 2 | 56 | | ]; |
| | | 57 | | |
| | | 58 | | /// <summary> |
| | | 59 | | /// Registers the metrics pipeline, or nothing at all when <paramref name="options" /> has |
| | | 60 | | /// metrics switched off — no meter listener, no exporter, no collection cost. |
| | | 61 | | /// </summary> |
| | | 62 | | public static IServiceCollection AddHeimdallMetrics(this IServiceCollection services, MetricsOptions options) |
| | | 63 | | { |
| | 976 | 64 | | if (!options.Enabled) |
| | | 65 | | { |
| | 1 | 66 | | return services; |
| | | 67 | | } |
| | | 68 | | |
| | 975 | 69 | | services.AddOpenTelemetry() |
| | 968 | 70 | | .ConfigureResource(resource => resource.AddService(ServiceName)) |
| | 1950 | 71 | | .WithMetrics(metrics => metrics |
| | 1950 | 72 | | .AddAspNetCoreInstrumentation() |
| | 1950 | 73 | | .AddHttpClientInstrumentation() |
| | 1950 | 74 | | .AddMeter(BuiltInMeters) |
| | 1950 | 75 | | .AddPrometheusExporter()); |
| | | 76 | | |
| | 975 | 77 | | return services; |
| | | 78 | | } |
| | | 79 | | |
| | | 80 | | /// <summary> |
| | | 81 | | /// Mounts the scrape endpoint behind <see cref="MetricsOptions.IsScrapeRequest" />. It must be |
| | | 82 | | /// called before anything else in the pipeline: the endpoint is a terminal branch, so a |
| | | 83 | | /// request it takes never reaches CORS, rate limiting, authentication, authorization or MVC — |
| | | 84 | | /// and, not being a controller action, it never appears in the OpenAPI document either. |
| | | 85 | | /// </summary> |
| | | 86 | | public static IApplicationBuilder UseHeimdallMetrics(this IApplicationBuilder app, MetricsOptions options) |
| | | 87 | | { |
| | 969 | 88 | | if (!options.Enabled) |
| | | 89 | | { |
| | 1 | 90 | | return app; |
| | | 91 | | } |
| | | 92 | | |
| | 968 | 93 | | return app.UseOpenTelemetryPrometheusScrapingEndpoint(options.IsScrapeRequest); |
| | | 94 | | } |
| | | 95 | | } |