prometheus-net.AspNetCore 8.2.1

Prefix Reserved
dotnet add package prometheus-net.AspNetCore --version 8.2.1                
NuGet\Install-Package prometheus-net.AspNetCore -Version 8.2.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="prometheus-net.AspNetCore" Version="8.2.1" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add prometheus-net.AspNetCore --version 8.2.1                
#r "nuget: prometheus-net.AspNetCore, 8.2.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.
// Install prometheus-net.AspNetCore as a Cake Addin
#addin nuget:?package=prometheus-net.AspNetCore&version=8.2.1

// Install prometheus-net.AspNetCore as a Cake Tool
#tool nuget:?package=prometheus-net.AspNetCore&version=8.2.1                

prometheus-net

This is a .NET library for instrumenting your applications and exporting metrics to Prometheus.

Build status Nuget Nuget

alternate text is missing from this package README image

The library targets the following runtimes (and newer):

  • .NET Framework 4.6.2
  • .NET 6.0

Table of contents

Best practices and usage

This library allows you to instrument your code with custom metrics and provides some built-in metric collection integrations for ASP.NET Core.

The documentation here is only a minimal quick start. For detailed guidance on using Prometheus in your solutions, refer to the prometheus-users discussion group. You are also expected to be familiar with the Prometheus user guide. /r/PrometheusMonitoring on Reddit may also prove a helpful resource.

Four types of metrics are available: Counter, Gauge, Summary and Histogram. See the documentation on metric types and instrumentation best practices to learn what each is good for.

The Metrics class is the main entry point to the API of this library. The most common practice in C# code is to have a static readonly field for each metric that you wish to export from a given class.

More complex patterns may also be used (e.g. combining with dependency injection). The library is quite tolerant of different usage models - if the API allows it, it will generally work fine and provide satisfactory performance. The library is thread-safe.

Quick start

After installing the library, you should:

  1. Collect some metrics, either by using built-in integrations or publishing your own custom metrics.
  2. Export the collected metrics over an HTTP endpoint (typically /metrics).
  3. Configure a Prometheus server to poll this endpoint for metrics on a regular interval.

Minimal sample app (based on .NET 6 Console app template):

using var server = new Prometheus.KestrelMetricServer(port: 1234);
server.Start();

Console.WriteLine("Open http://localhost:1234/metrics in a web browser.");
Console.WriteLine("Press enter to exit.");
Console.ReadLine();

Refer to the sample projects for quick start instructions:

Name Description
Sample.Web ASP.NET Core application that produces custom metrics and uses multiple integrations to publish built-in metrics
Sample.Console .NET console application that exports custom metrics
Sample.Console.DotNetMeters Demonstrates how to publish custom metrics via the .NET Meters API
Sample.Console.Exemplars .NET console application that attaches exemplars to some metrics
Sample.Console.NetFramework Same as above but targeting .NET Framework
Sample.Console.NoAspNetCore .NET console application that exports custom metrics without requiring the ASP.NET Core runtime to be installed
Sample.Grpc ASP.NET Core application that publishes a gRPC service
Sample.Grpc.Client Client app for the above
Sample.NetStandard Demonstrates how to reference prometheus-net in a .NET Standard class library
Sample.Web.DifferentPort Demonstrates how to set up the metric exporter on a different port from the main web API (e.g. for security purposes)
Sample.Web.MetricExpiration Demonstrates how to use automatic metric deletion
Sample.Web.NetFramework .NET Framework web app that publishes custom metrics

The rest of this document describes how to use individual features of the library.

Installation

Nuget package for general use and metrics export via HttpListener or to Pushgateway: prometheus-net

Install-Package prometheus-net

Nuget package for ASP.NET Core middleware and stand-alone Kestrel metrics server: prometheus-net.AspNetCore

Install-Package prometheus-net.AspNetCore

Nuget package for ASP.NET Core Health Check integration: prometheus-net.AspNetCore.HealthChecks

Install-Package prometheus-net.AspNetCore.HealthChecks

Nuget package for ASP.NET Core gRPC integration: prometheus-net.AspNetCore.Grpc

Install-Package prometheus-net.AspNetCore.Grpc

Nuget package for ASP.NET Web API middleware on .NET Framework: prometheus-net.NetFramework.AspNet

Install-Package prometheus-net.NetFramework.AspNet

Counters

Counters only increase in value and reset to zero when the process restarts.

private static readonly Counter ProcessedJobCount = Metrics
    .CreateCounter("myapp_jobs_processed_total", "Number of processed jobs.");

...

ProcessJob();
ProcessedJobCount.Inc();

Gauges

Gauges can have any numeric value and change arbitrarily.

private static readonly Gauge JobsInQueue = Metrics
    .CreateGauge("myapp_jobs_queued", "Number of jobs waiting for processing in the queue.");

...

jobQueue.Enqueue(job);
JobsInQueue.Inc();

...

var job = jobQueue.Dequeue();
JobsInQueue.Dec();

Histogram

Histograms track the size and number of events in buckets. This allows for aggregatable calculation of quantiles.

private static readonly Histogram OrderValueHistogram = Metrics
    .CreateHistogram("myapp_order_value_usd", "Histogram of received order values (in USD).",
        new HistogramConfiguration
        {
            // We divide measurements in 10 buckets of $100 each, up to $1000.
            Buckets = Histogram.LinearBuckets(start: 100, width: 100, count: 10)
        });

...

OrderValueHistogram.Observe(order.TotalValueUsd);

Summary

Summaries track the trends in events over time (10 minutes by default).

private static readonly Summary RequestSizeSummary = Metrics
    .CreateSummary("myapp_request_size_bytes", "Summary of request sizes (in bytes) over last 10 minutes.");

...

RequestSizeSummary.Observe(request.Length);

By default, only the sum and total count are reported. You may also specify quantiles to measure:

private static readonly Summary RequestSizeSummary = Metrics
    .CreateSummary("myapp_request_size_bytes", "Summary of request sizes (in bytes) over last 10 minutes.",
        new SummaryConfiguration
        {
            Objectives = new[]
            {
                new QuantileEpsilonPair(0.5, 0.05),
                new QuantileEpsilonPair(0.9, 0.05),
                new QuantileEpsilonPair(0.95, 0.01),
                new QuantileEpsilonPair(0.99, 0.005),
            }
        });

The epsilon indicates the absolute error allowed in measurements. For more information, refer to the Prometheus documentation on summaries and histograms.

Measuring operation duration

Timers can be used to report the duration of an operation (in seconds) to a Summary, Histogram, Gauge or Counter. Wrap the operation you want to measure in a using block.

private static readonly Histogram LoginDuration = Metrics
    .CreateHistogram("myapp_login_duration_seconds", "Histogram of login call processing durations.");

...

using (LoginDuration.NewTimer())
{
    IdentityManager.AuthenticateUser(Request.Credentials);
}

Tracking in-progress operations

You can use Gauge.TrackInProgress() to track how many concurrent operations are taking place. Wrap the operation you want to track in a using block.

private static readonly Gauge DocumentImportsInProgress = Metrics
    .CreateGauge("myapp_document_imports_in_progress", "Number of import operations ongoing.");

...

using (DocumentImportsInProgress.TrackInProgress())
{
    DocumentRepository.ImportDocument(path);
}

Counting exceptions

You can use Counter.CountExceptions() to count the number of exceptions that occur while executing some code.

private static readonly Counter FailedDocumentImports = Metrics
    .CreateCounter("myapp_document_imports_failed_total", "Number of import operations that failed.");

...

FailedDocumentImports.CountExceptions(() => DocumentRepository.ImportDocument(path));

You can also filter the exception types to observe:

FailedDocumentImports.CountExceptions(() => DocumentRepository.ImportDocument(path), IsImportRelatedException);

bool IsImportRelatedException(Exception ex)
{
    // Do not count "access denied" exceptions - those are user error for pointing us to a forbidden file.
    if (ex is UnauthorizedAccessException)
        return false;

    return true;
}

Labels

All metrics can have labels, allowing grouping of related time series.

See the best practices on naming and labels.

Taking a counter as an example:

private static readonly Counter RequestCountByMethod = Metrics
    .CreateCounter("myapp_requests_total", "Number of requests received, by HTTP method.", labelNames: new[] { "method" });

...

// You can specify the values for the labels later, once you know the right values (e.g in your request handler code).
RequestCountByMethod.WithLabels("GET").Inc();

NB! Best practices of metric design is to minimize the number of different label values. For example:

  • HTTP request method is a good choice for labeling - there are not many values.
  • URL is a bad choice for labeling - it has many possible values and would lead to significant data processing inefficiency.

Static labels

You can add static labels that always have fixed values. This is possible on two levels:

  • on the metrics registry (e.g. Metrics.DefaultRegistry)
  • on a metric factory (e.g. Metrics.WithLabels())

All levels of labeling can be combined and instance-specific metric labels can also be applied on top, as usual.

Example with static labels on two levels and one instance-specific label:

Metrics.DefaultRegistry.SetStaticLabels(new Dictionary<string, string>
{
  // Labels applied to all metrics in the registry.
  { "environment", "testing" }
});

var backgroundServicesMetricFactory = Metrics.WithLabels(new Dictionary<string, string>
{
  // Labels applied to all metrics created via this factory.
  { "category", "background-services" }
});

var requestsHandled = backgroundServicesMetricFactory
  .CreateCounter("myapp_requests_handled_total", "Count of requests handled, labelled by response code.", labelNames: new[] { "response_code" });

// Labels applied to individual instances of the metric.
requestsHandled.WithLabels("404").Inc();
requestsHandled.WithLabels("200").Inc();

Exemplars

Exemplars facilitate distributed tracing, by attaching related trace IDs to metrics. This enables a metrics visualization app to cross-reference traces that explain how the metric got the value it has.

alternate text is missing from this package README image

See also, Grafana fundamentals - introduction to exemplars.

By default, prometheus-net will create an exemplar with the trace_id and span_id labels based on the current distributed tracing context (Activity.Current). If using OpenTelemetry tracing with ASP.NET Core, the traceparent HTTP request header will be used to automatically assign Activity.Current.

private static readonly Counter TotalSleepTime = Metrics
    .CreateCounter("sample_sleep_seconds_total", "Total amount of time spent sleeping.");
...

// You only need to create the Activity if one is not automatically assigned (e.g. by ASP.NET Core).
using (var activity = new Activity("Pausing before record processing").Start())
{
    var sleepStopwatch = Stopwatch.StartNew();
    await Task.Delay(TimeSpan.FromSeconds(1));

    // The trace_id and span_id from the current Activity are exposed as the exemplar.
    TotalSleepTime.Inc(sleepStopwatch.Elapsed.TotalSeconds);
}

This will be published as the following metric point:

sample_sleep_seconds_total 251.03833569999986 # {trace_id="08ad1c8cec52bf5284538abae7e6d26a",span_id="4761a4918922879b"} 1.0010688 1672634812.125

You can override any default exemplar logic by providing your own exemplar when updating the value of the metric:

private static readonly Counter RecordsProcessed = Metrics
    .CreateCounter("sample_records_processed_total", "Total number of records processed.");

// The key from an exemplar key-value pair should be created once and reused to minimize memory allocations.
private static readonly Exemplar.LabelKey RecordIdKey = Exemplar.Key("record_id");
...

foreach (var record in recordsToProcess)
{
    var exemplar = Exemplar.From(RecordIdKey.WithValue(record.Id.ToString()));
    RecordsProcessed.Inc(exemplar);
}

Warning Exemplars are limited to 128 ASCII characters (counting both keys and values) - they are meant to contain IDs for cross-referencing with trace databases, not as a replacement for trace databases.

Exemplars are only published if the metrics are being scraped by an OpenMetrics-capable client. For development purposes, you can force the library to use the OpenMetrics exposition format by adding ?accept=application/openmetrics-text to the /metrics URL.

Note The Prometheus database automatically negotiates OpenMetrics support when scraping metrics - you do not need to apply any special scraping configuration in production scenarios. You may need to enable exemplar storage, though.

See also, Sample.Console.Exemplars.

Limiting exemplar volume

Exemplars can be expensive to store in the metrics database. For this reason, it can be useful to only record exemplars for "interesting" metric values.

You can use ExemplarBehavior.NewExemplarMinInterval to define a minimum interval between exemplars - a new exemplar will only be recorded if this much time has passed. This can be useful to limit the rate of publishing unique exemplars.

You can customize the default exemplar provider via IMetricFactory.ExemplarBehavior or CounterConfiguration.ExemplarBehavior and HistogramConfiguration.ExemplarBehavior, which allows you to provide your own method to generate exemplars and to filter which values/metrics exemplars are recorded for:

Example of a custom exemplar provider used together with exemplar rate limiting:

// For the next histogram we only want to record exemplars for values larger than 0.1 (i.e. when record processing goes slowly).
static Exemplar RecordExemplarForSlowRecordProcessingDuration(Collector metric, double value)
{
    if (value < 0.1)
        return Exemplar.None;

    return Exemplar.FromTraceContext();
}

var recordProcessingDuration = Metrics
    .CreateHistogram("sample_record_processing_duration_seconds", "How long it took to process a record, in seconds.",
    new HistogramConfiguration
    {
        Buckets = Histogram.PowersOfTenDividedBuckets(-4, 1, 5),
        ExemplarBehavior = new()
        {
            DefaultExemplarProvider = RecordExemplarForSlowRecordProcessingDuration,
            // Even if we have interesting data more often, do not record it to conserve exemplar storage.
            NewExemplarMinInterval = TimeSpan.FromMinutes(5)
        }
    });

For the ASP.NET Core HTTP server metrics, you can further fine-tune exemplar recording by inspecting the HTTP request and response:

app.UseHttpMetrics(options =>
{
    options.ConfigureMeasurements(measurementOptions =>
    {
        // Only measure exemplar if the HTTP response status code is not "OK".
        measurementOptions.ExemplarPredicate = context => context.Response.StatusCode != HttpStatusCode.Ok;
    });
});

When are metrics published?

Metrics without labels are published immediately after the Metrics.CreateX() call. Metrics that use labels are published when you provide the label values for the first time.

Sometimes you want to delay publishing a metric until you have loaded some data and have a meaningful value to supply for it. The API allows you to suppress publishing of the initial value until you decide the time is right.

private static readonly Gauge UsersLoggedIn = Metrics
    .CreateGauge("myapp_users_logged_in", "Number of active user sessions",
        new GaugeConfiguration
        {
            SuppressInitialValue = true
        });

...

// After setting the value for the first time, the metric becomes published.
UsersLoggedIn.Set(LoadSessions().Count);

You can also use .Publish() on a metric to mark it as ready to be published without modifying the initial value (e.g. to publish a zero). Conversely, you can use .Unpublish() to hide a metric temporarily. Note that the metric remains in memory and retains its value.

Deleting metrics

You can use .Dispose() or .RemoveLabelled() methods on the metric classes to manually delete metrics at any time.

In some situations, it can be hard to determine when a metric with a specific set of labels becomes irrelevant and needs to be removed. The library provides some assistance here by enabling automatic expiration of metrics when they are no longer used.

To enable automatic expiration, create the metrics via the metric factory returned by Metrics.WithManagedLifetime(). All such metrics will have a fixed expiration time, with the expiration restarting based on certain conditions that indicate the metric is in use.

Option 1: metric lifetime can be controlled by leases - the metric expiration timer starts when the last lease is released (and will be reset when a new lease is taken again).

var factory = Metrics.WithManagedLifetime(expiresAfter: TimeSpan.FromMinutes(5));

// With expiring metrics, we get back handles to the metric, not the metric directly.
var inProgressHandle = expiringMetricFactory
  .CreateGauge("documents_in_progress", "Number of documents currently being processed.",
    // Automatic metric deletion only makes sense if we have a high/unknown cardinality label set,
    // so here is a sample label for each "document provider", whoever that may be.
    labelNames: new[] { "document_provider" });

...

public void ProcessDocument(string documentProvider)
{
  // Automatic metric deletion will not occur while this lease is held.
  // This will also reset any existing expiration timer for this document provider.
  inProgressHandle.WithLease(metric =>
  {
    using (metric.TrackInProgress())
      DoDocumentProcessingWork();
  }, documentProvider);
  // Lease is released here.
  // If this was the last lease for this document provider, the expiration timer will now start.
}

Scenario 2: sometimes managing the leases is not required because you simply want the metric lifetime to be extended whenever the value is updated.

var factory = Metrics.WithManagedLifetime(expiresAfter: TimeSpan.FromMinutes(5));

// With expiring metrics, we get back handles to the metric, not the metric directly.
var processingStartedHandle = expiringMetricFactory
  .CreateGauge("documents_started_processing_total", "Number of documents for which processing has started.",
    // Automatic metric deletion only makes sense if we have a high/unknown cardinality label set,
    // so here is a sample label for each "document provider", whoever that may be.
    labelNames: new[] { "document_provider" });

// This returns a metric instance that will reset the expiration timer whenever the metric value is updated.
var processingStarted = processingStartedHandle.WithExtendLifetimeOnUse();

...

public void ProcessDocument(string documentProvider)
{
  // This will reset the expiration timer for this document provider.
  processingStarted.WithLabels(documentProvider).Inc();

  DoDocumentProcessingWork();
}

The expiration logic is scoped to the factory. Multiple handles for the same metric from the same factory will share their expiration logic. However, handles for the same metric from different factories will have independent expiration logic.

See also, Sample.Web.MetricExpiration.

ASP.NET Core exporter middleware

For projects built with ASP.NET Core, a middleware plugin is provided.

If you use the default Visual Studio project templates, modify the UseEndpoints call as follows:

  • Add endpoints.MapMetrics() anywhere in the delegate body.
public void Configure(IApplicationBuilder app, ...)
{
    // ...

    app.UseEndpoints(endpoints =>
    {
        // ...

        endpoints.MapMetrics();
    });
}

The default configuration will publish metrics on the /metrics URL.

The ASP.NET Core functionality is delivered in the prometheus-net.AspNetCore NuGet package.

See also, Sample.Web.

ASP.NET Core HTTP request metrics

The library exposes some metrics from ASP.NET Core applications:

  • Number of HTTP requests in progress.
  • Total number of received HTTP requests.
  • Duration of HTTP requests.

The ASP.NET Core functionality is delivered in the prometheus-net.AspNetCore NuGet package.

You can expose HTTP metrics by modifying your Startup.Configure() method:

  • After app.UseRouting() add app.UseHttpMetrics().

Example Startup.cs:

public void Configure(IApplicationBuilder app, ...)
{
    // ...

    app.UseRouting();
    app.UseHttpMetrics();

    // ...
}

By default, metrics are collected separately for each response status code (200, 201, 202, 203, ...). You can considerably reduce the size of the data set by only preserving information about the first digit of the status code:

app.UseHttpMetrics(options =>
{
    // This will preserve only the first digit of the status code.
    // For example: 200, 201, 203 -> 2xx
    options.ReduceStatusCodeCardinality();
});

NB! Exception handler middleware that changes HTTP response codes must be registered after UseHttpMetrics() in order to ensure that prometheus-net reports the correct HTTP response status code.

The action, controller and endpoint route parameters are always captured by default. If Razor Pages is in use, the page label will be captured to show the path to the page.

You can include additional route parameters as follows:

app.UseHttpMetrics(options =>
{
    // Assume there exists a custom route parameter with this name.
    options.AddRouteParameter("api-version");
});

You can also extract arbitrary data from the HttpContext into label values as follows:

app.UseHttpMetrics(options =>
{
    options.AddCustomLabel("host", context => context.Request.Host.Host);
});

See also, Sample.Web.

ASP.NET Core gRPC request metrics

The library allows you to expose some metrics from ASP.NET Core gRPC services. These metrics include labels for service and method name.

You can expose gRPC metrics by modifying your Startup.Configure() method:

  • After app.UseRouting() add app.UseGrpcMetrics().

Example Startup.cs:

public void Configure(IApplicationBuilder app, ...)
{
    // ...

    app.UseRouting();
    app.UseGrpcMetrics();

    // ...
}

The gRPC functionality is delivered in the prometheus-net.AspNetCore.Grpc NuGet package.

See also, Sample.Grpc.

IHttpClientFactory metrics

This library allows you to expose metrics about HttpClient instances created using IHttpClientFactory.

The exposed metrics include:

  • Number of HTTP requests in progress.
  • Total number of started HTTP requests.
  • Duration of HTTP client requests (from start of request to end of reading response headers).
  • Duration of HTTP client responses (from start of request to end of reading response body).

Example Startup.cs modification to enable these metrics for all HttpClients registered in the service collection:

public void ConfigureServices(IServiceCollection services)
{
    // ...

    services.UseHttpClientMetrics();

    // ...
}

Note You can also register HTTP client metrics only for a specific HttpClient by calling services.AddHttpClient(...).UseHttpClientMetrics().

See also, Sample.Web.

ASP.NET Core health check status metrics

You can expose the current status of ASP.NET Core health checks as Prometheus metrics by extending your IHealthChecksBuilder in the Startup.ConfigureServices() method:

public void ConfigureServices(IServiceCollection services, ...)
{
    // ...

    services.AddHealthChecks()
        // ...
        <Your Health Checks>
        // ...
        .ForwardToPrometheus();

    // ...
}

The status of each health check will be published in the aspnetcore_healthcheck_status metric.

The ASP.NET Core health check integration is delivered in the prometheus-net.AspNetCore.HealthChecks NuGet package.

See also, Sample.Web.

Protecting the metrics endpoint from unauthorized access

You may wish to restrict access to the metrics export URL. Documentation on how to apply ASP.NET Core security mechanisms is beyond the scope of this readme file but a good starting point may be to require an authorization policy to be satisfied for accessing the endpoint

app.UseEndpoints(endpoints =>
{
    // ...

    // Assumes that you have previously configured the "ReadMetrics" policy (not shown).
    endpoints.MapMetrics().RequireAuthorization("ReadMetrics");
});

Another commonly used option is to expose a separate web server endpoint (e.g. a new KestrelMetricServer instance) on a different port, with firewall rules limiting access to only certain IP addresses. Refer to the sample project Sample.Web.DifferentPort.

ASP.NET Web API exporter

The easiest way to export metrics from an ASP.NET Web API app on the full .NET Framework is to use AspNetMetricServer in your Global.asax.cs file. Insert the following line to the top of the Application_Start method:

protected void Application_Start(object sender, EventArgs e)
{
    AspNetMetricServer.RegisterRoutes(GlobalConfiguration.Configuration);

    // Other code follows.
}

The above snippet exposes metrics on the /metrics URL.

The AspNetMetricServer class is provided by the prometheus-net.NetFramework.AspNet NuGet package.

Kestrel stand-alone server

In some situation, you may wish to start a stand-alone metric server using Kestrel (e.g. if your app has no other HTTP-accessible functionality).

var metricServer = new KestrelMetricServer(port: 1234);
metricServer.Start();

The default configuration will publish metrics on the /metrics URL.

If your app is an ASP.NET Core web app, you can use a pipeline-integrated mechanism:

services.AddMetricServer(options =>
{
    options.Port = 1234;
});

Publishing to Pushgateway

Metrics can be posted to a Pushgateway server.

var pusher = new MetricPusher(new MetricPusherOptions
{
    Endpoint = "https://pushgateway.example.org:9091/metrics",
    Job = "some_job"
});

pusher.Start();

Note that the default behavior of the metric pusher is to append metrics. You can use MetricPusherOptions.ReplaceOnPush to make it replace existing metrics in the same group, removing any that are no longer pushed.

Publishing to Pushgateway with basic authentication

You can use a custom HttpClient to supply credentials for the Pushgateway.

// Placeholder username and password here - replace with your own data.
var headerValue = Convert.ToBase64String(Encoding.UTF8.GetBytes("username:password"));
var httpClient = new HttpClient();
httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", headerValue);

var pusher = new MetricPusher(new MetricPusherOptions
{
    Endpoint =  "https://pushgateway.example.org:9091/metrics",
    Job = "some_job",
    HttpClientProvider = () => httpClient
});

pusher.Start();

Publishing via standalone HTTP handler

As a fallback option for scenarios where Kestrel or ASP.NET Core hosting is unsuitable, an HttpListener based metrics server implementation is also available.

var metricServer = new MetricServer(port: 1234);
metricServer.Start();

The default configuration will publish metrics on the /metrics URL.

MetricServer.Start() may throw an access denied exception on Windows if your user does not have the right to open a web server on the specified port. You can use the netsh command to grant yourself the required permissions:

netsh http add urlacl url=http://+:1234/metrics user=DOMAIN\user

Publishing raw metrics document

In scenarios where you handle publishing via a custom endpoint, you can export the entire metrics data set as a Prometheus text document.

await Metrics.DefaultRegistry.CollectAndExportAsTextAsync(outputStream);

Just-in-time updates

In some scenarios you may want to only collect data when it is requested by Prometheus. To easily implement this scenario prometheus-net enables you to register a callback before every collection occurs. Register your callback using Metrics.DefaultRegistry.AddBeforeCollectCallback().

Every callback will be executed before each collection, which will not finish until every callback has finished executing. Prometheus will expect each scrape to complete within a certain amount of seconds. To avoid timeouts, ensure that any registered callbacks execute quickly.

  • A synchronous callback (of type Action) should not take more than a few milliseconds. Do not read data from remote systems in these callbacks.
  • An asynchronous callback (of type Func<CancellationToken, Task>) is more suitable for long-running data collection work (lasting a few seconds). You can use asynchronous callbacks for reading data from remote systems.
Metrics.DefaultRegistry.AddBeforeCollectCallback(async (cancel) =>
{
    // Probe a remote system.
    var response = await httpClient.GetAsync("https://google.com", cancel);

    // Increase a counter by however many bytes we loaded.
    googlePageBytes.Inc(response.Content.Headers.ContentLength ?? 0);
});

Suppressing default metrics

The library enables various default metrics and integrations by default. If these default metrics are not desirable you may remove them by calling Metrics.SuppressDefaultMetrics() before registering any of your own metrics.

DiagnosticSource integration

.NET Core provides the DiagnosticSource mechanism for reporting diagnostic events, used widely by .NET and ASP.NET Core classes. To expose basic data on these events via Prometheus, you can use the DiagnosticSourceAdapter class:

// An optional "options" parameter is available to customize adapter behavior.
var registration = DiagnosticSourceAdapter.StartListening();

...

// Stops listening for DiagnosticSource events.
registration.Dispose();

Any events that occur are exported as Prometheus metrics, indicating the name of the event source and the name of the event:

diagnostic_events_total{source="Microsoft.AspNetCore",event="Microsoft.AspNetCore.Mvc.AfterAction"} 4
diagnostic_events_total{source="HttpHandlerDiagnosticListener",event="System.Net.Http.Request"} 8

The level of detail obtained from this is rather low - only the total count for each event is exported. For more fine-grained analytics, you need to listen to DiagnosticSource events on your own and create custom metrics that can understand the meaning of each particular type of event that is of interest to you.

EventCounter integration

Note The output produced by this integration has changed significantly between prometheus-net 6.0 and prometheus-net 7.0. The old output format is no longer supported.

.NET Core provides the EventCounter mechanism for reporting diagnostic events, used used widely by .NET and ASP.NET Core classes. This library publishes all .NET EventCounter data by default. To suppress this, see Suppressing default metrics.

You can configure the integration using Metrics.ConfigureEventCounterAdapter().

By default, prometheus-net will only publish the well-known .NET EventCounters to minimize resource consumption in the default configuration. A custom event source filter must be provided in the configuration to enable publishing of additional event counters.

See also, Sample.Console.

.NET Meters integration

Note The output produced by this integration has changed significantly between prometheus-net 6.0 and prometheus-net 7.0. The old output format is no longer supported.

.NET provides the Meters mechanism for reporting diagnostic metrics. This library publishes all .NET Meters API data by default. To suppress this, see Suppressing default metrics.

You can configure the integration using Metrics.ConfigureMeterAdapter().

See also, Sample.Console.DotNetMeters.

Benchmarks

A suite of benchmarks is included if you wish to explore the performance characteristics of the library. Simply build and run the Benchmarks.NetCore project in Release mode.

As an example of the performance of measuring data using prometheus-net, we have the results of the MeasurementBenchmarks here, converted into measurements per second:

Metric type Measurements per second
Counter 261 million
Gauge 591 million
Histogram (16 buckets) 105 million
Histogram (128 buckets) 65 million

Another popular .NET SDK with Prometheus support is the OpenTelemetry SDK. To help you choose, we have SdkComparisonBenchmarks.cs to compare the two SDKs and give some idea of how they differer in the performance tradeoffs made. Both SDKs are evaluated in single-threaded mode under a comparable workload and enabled feature set. A representative result is here:

SDK Benchmark scenario CPU time Memory
prometheus-net Counter (existing timeseries) x100K 230 µs None
OpenTelemetry Counter (existing timeseries) x100K 10998 µs None
prometheus-net Histogram (existing timeseries) x100K 957 µs None
OpenTelemetry Histogram (existing timeseries) x100K 12110 µs None
prometheus-net Histogram (new timeseries) x1K 716 µs 664 KB
OpenTelemetry Histogram (new timeseries) x1K 350 µs 96 KB

Community projects

Some useful related projects are:

Note: to avoid confusion between "official" prometheus-net and community maintained packages, the prometheus-net namespace is protected on nuget.org. However, the prometheus-net.Contrib.* namespace allows package publishing by all authors.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (104)

Showing the top 5 NuGet packages that depend on prometheus-net.AspNetCore:

Package Downloads
prometheus-net.AspNetCore.HealthChecks

ASP.NET Core Health Checks integration with Prometheus

prometheus-net.AspNetCore.Grpc

ASP.NET Core gRPC integration with Prometheus

MyJetWallet.Sdk.Service

Package Description

CUSTIS.NetCore.AppHost

Инструменты для хостинга приложения

KubeOps

This is an operator sdk written in c#. It enables a developer to create a custom controller for CRDs (CustomResourceDefinitions) that runs on kubernetes.

GitHub repositories (32)

Showing the top 5 popular GitHub repositories that depend on prometheus-net.AspNetCore:

Repository Stars
jellyfin/jellyfin
The Free Software Media System
microsoft/reverse-proxy
A toolkit for developing high-performance HTTP reverse proxy applications.
ivanpaulovich/clean-architecture-manga
:cyclone: Clean Architecture with .NET6, C#10 and React+Redux. Use cases as central organizing structure, completely testable, decoupled from frameworks
Azure/iotedge
The IoT Edge OSS project
AlphaYu/adnc
.NET微服务/分布式开发框架,同时也适用于单体架构系统的开发。
Version Downloads Last updated
8.2.1 5,874,641 1/3/2024
8.2.1-pre-240103185829-60e9106 718 1/3/2024
8.2.0 760,521 12/5/2023
8.2.0-pre-231205215128-a2c1c8f 895 12/5/2023
8.2.0-pre-231205134623-36b4750 868 12/5/2023
8.2.0-pre-231204222617-7837255 888 12/4/2023
8.2.0-pre-231204170437-99f640f 942 12/4/2023
8.2.0-pre-231204094406-885f52c 823 12/4/2023
8.2.0-pre-231204084751-4d19b42 865 12/4/2023
8.2.0-pre-231128134008-9a7dad2 1,360 11/28/2023
8.1.1 330,830 11/28/2023
8.1.1-pre-231128114341-17bb2a0 884 11/28/2023
8.1.0 992,811 10/29/2023
8.1.0-pre-231028004937-71a8668 2,254 10/28/2023
8.0.1 3,460,353 7/18/2023
8.0.1-pre-230718073955-ea794f6 1,267 7/18/2023
8.0.1-pre-230718042806-718dffc 1,295 7/18/2023
8.0.0 6,648,918 2/17/2023
8.0.0-pre-230212122408-a055f5b 4,519 2/12/2023
8.0.0-pre-230210074852-a7c1277 1,266 2/10/2023
8.0.0-pre-230209100041-c35ac64 3,247 2/9/2023
8.0.0-pre-230209074620-4f8f59c 1,307 2/9/2023
8.0.0-pre-230203154858-4bf76fb 2,023 2/3/2023
8.0.0-pre-230203125716-1813839 1,254 2/3/2023
8.0.0-pre-230203073826-06c2e2f 2,422 2/3/2023
8.0.0-pre-230201062733-ece2743 1,424 2/1/2023
8.0.0-pre-230127154206-9ec9e9b 3,347 1/27/2023
8.0.0-pre-230127124604-8b7c7e1 1,297 1/27/2023
8.0.0-pre-230127111923-d72115a 1,301 1/27/2023
8.0.0-pre-230127084218-90f4311 1,269 1/27/2023
8.0.0-pre-230127075825-bfc1041 1,324 1/27/2023
8.0.0-pre-230126143551-210a1ab 1,369 1/26/2023
8.0.0-pre-230119065217-312c2e9 4,427 1/19/2023
8.0.0-pre-230116052305-1ed397b 2,217 1/16/2023
8.0.0-pre-230102092516-2351266 4,034 1/2/2023
8.0.0-pre-230101195105-9f23889 1,291 1/1/2023
8.0.0-pre-230101084444-630935f 1,296 1/1/2023
8.0.0-pre-221231102537-13e7ac6 1,290 12/31/2022
8.0.0-pre-221231100152-fb39dcb 1,288 12/31/2022
8.0.0-pre-000342-4d6812e 1,395 12/29/2022
7.1.0-pre-000318-0479f53 33,644 11/15/2022
7.1.0-pre-000310-9c9e1e9 3,484 11/7/2022
7.1.0-pre-000307-f980713 2,598 10/27/2022
7.0.0 5,837,760 10/26/2022
7.0.0-pre-000305-75cc817 5,400 10/17/2022
7.0.0-pre-000304-cbb305a 1,222 10/17/2022
7.0.0-pre-000303-5a44ada 1,288 10/16/2022
7.0.0-pre-000301-06c5932 1,405 10/13/2022
7.0.0-pre-000298-4b8d3e7 1,277 10/13/2022
7.0.0-pre-000297-7068d28 1,217 10/13/2022
7.0.0-pre-000296-5b1a1c4 4,476 10/5/2022
7.0.0-pre-000294-486fcd8 1,289 10/5/2022
7.0.0-pre-000293-d13fe06 2,010 10/4/2022
7.0.0-pre-000292-88fbe2a 1,250 10/4/2022
7.0.0-pre-000288-4688bd3 1,735 10/2/2022
7.0.0-pre-000282-d90ebf3 2,356 9/28/2022
7.0.0-pre-000280-ce6d494 1,256 9/28/2022
7.0.0-pre-000277-6bc5023 1,303 9/27/2022
7.0.0-pre-000276-9e65611 1,470 9/23/2022
7.0.0-pre-000270-ee6c23e 1,345 9/23/2022
7.0.0-pre-000269-08d9f2c 1,234 9/22/2022
7.0.0-pre-000259-7317089 1,457 9/21/2022
7.0.0-pre-000244-66d82e6 1,315 9/19/2022
6.0.0 14,879,614 3/3/2022
6.0.0-pre-000234-4598e28 1,300 3/3/2022
6.0.0-pre-000233-0dd30d3 2,076 3/2/2022
6.0.0-pre-000231-38d45fa 49,325 2/20/2022
6.0.0-pre-000223-ab9edeb 1,371 2/18/2022
5.1.0-pre-000215-c81d12d 12,101 1/22/2022
5.0.2 5,398,154 11/19/2021
5.0.2-pre-000210-fbf24c8 4,840 11/19/2021
5.0.1 4,070,082 8/19/2021
5.0.1-pre-000202-59e0610 1,334 8/19/2021
5.0.0 118,959 8/18/2021
5.0.0-pre-000201-8d79f11 3,498 7/30/2021
5.0.0-pre-000200-0afede9 1,530 7/30/2021
4.3.0-pre-000199-35f4961 1,404 7/29/2021
4.3.0-pre-000198-79466f7 1,418 7/29/2021
4.2.0 1,947,483 7/6/2021
4.2.0-pre-000195-ec10b08 1,381 7/6/2021
4.2.0-pre-000194-7aacfb0 1,387 7/6/2021
4.1.1 8,370,733 12/12/2020
4.1.1-pre-000180-1cfbebb 1,574 12/12/2020
4.1.0 9,943 12/12/2020
4.1.0-pre-000179-9582014 1,617 12/12/2020
4.1.0-pre-000171-15be8f3 5,360 12/6/2020
4.0.0 1,654,916 10/18/2020
4.0.0-pre-000158-d425fff 1,600 10/18/2020
4.0.0-pre-000134-2fea549 68,515 7/6/2020
3.6.0 4,431,363 6/19/2020
3.6.0-pre-000131-673cfe2 1,574 6/19/2020
3.6.0-pre-000129-bd91778 3,531 6/16/2020
3.5.0 3,139,258 3/9/2020
3.5.0-pre-000099-ee2bdbd 1,653 3/9/2020
3.5.0-pre-000098-f9cb93e 5,444 2/9/2020
3.4.0 1,725,933 12/26/2019
3.4.0-pre-000084-e9d0f37 1,640 12/26/2019
3.4.0-pre-000082-546478d 3,140 12/23/2019
3.4.0-pre-000081-1712a44 1,654 12/23/2019
3.4.0-pre-000079-eff2a83 1,634 12/22/2019
3.4.0-pre-000078-34a900d 1,706 12/22/2019
3.4.0-pre-000077-0ace5bd 1,716 12/20/2019
3.4.0-pre-000067-701dfdc 1,584 12/19/2019
3.3.1-pre-000052-0842664 3,044 12/13/2019
3.3.0 2,966,185 10/18/2019
3.3.0-pre-000042-252e89c 1,628 10/18/2019
3.2.1 340,498 10/2/2019
3.2.1-pre-000036-696f4ab 1,683 10/2/2019
3.2.0 2,438 10/1/2019
3.2.0-pre-000035-8d4cf7d 1,660 10/1/2019
3.2.0-pre-000032-9939133 1,589 9/25/2019
3.2.0-pre-000028-abe3225 1,656 9/25/2019
3.2.0-pre-000027-29e0fce 1,682 9/25/2019
3.1.5-pre-000023-d29ca37 2,048 9/24/2019
3.1.5-pre-000021-8c7b328 1,662 9/24/2019
3.1.5-pre-000020-5a2fc50 1,624 9/24/2019
3.1.4 1,429,844 6/20/2019
3.1.4-pre-000016-95d0170 1,642 6/20/2019
3.1.3 230,252 5/30/2019
3.1.3-pre-000009-505a08e 1,656 5/29/2019
3.1.3-cb-000009-505a08e 1,663 5/29/2019
3.1.2 196,544 4/27/2019
3.1.2-pre-006681-4f8ce09 1,829 4/23/2019
3.1.1 170,124 4/10/2019
3.1.1-pre-006463-cd3cd18 1,671 4/10/2019
3.1.0 66,578 3/29/2019
3.1.0-pre-006304-959164e 1,650 3/27/2019
3.1.0-pre-006267-9aac888 4,585 3/22/2019
3.1.0-pre-006177-d35e0b8 1,842 3/15/2019
3.0.3 289,621 2/11/2019
3.0.2 4,799 2/7/2019
3.0.1 3,003 2/6/2019
3.0.0 13,593 2/5/2019
3.0.0-pre-005830-d9493da 1,785 2/4/2019
3.0.0-pre-005828-27b7100 1,722 2/4/2019
3.0.0-pre-005823-68ad8e2 1,789 2/4/2019
3.0.0-pre-005803-4289c4a 1,756 2/1/2019
3.0.0-pre-005801-6f306bc 1,757 1/31/2019
3.0.0-pre-005800-ec1da05 1,758 1/31/2019
3.0.0-pre-005795-6aca95b 1,826 1/30/2019
3.0.0-pre-005647-e277cbe 1,826 1/9/2019
2.1.3 835,509 9/25/2018
2.1.3-pre-005238-380e4ab 1,797 9/25/2018
2.1.2 18,820 9/6/2018
2.1.2-pre-005131-012bc01 1,951 9/6/2018
2.1.1-pre-004445-bc00b93 4,296 5/25/2018
2.1.0 258,520 4/13/2018
2.1.0-pre-003985-910fb52 2,088 4/11/2018
2.1.0-pre-003982-37c9f93 2,076 4/11/2018
2.0.0 85,757 2/26/2018
2.0.0-pre-003523-49de0a3 2,979 2/22/2018
2.0.0-pre-003112-3de1c34 3,101 2/7/2018
2.0.0-pre-003077-0447c86 2,655 2/5/2018
2.0.0-pre-003054-ffb96c7 2,088 2/1/2018
2.0.0-pre-003051-6f12a46 2,101 2/1/2018
2.0.0-pre-003009-4e26344 1,970 1/27/2018
2.0.0-pre-002968-9fcb8aa 2,037 1/25/2018