prom-client-net / prom-client-httprequestdurations

Metrics logging of request durations for the Prometheus.Client

Prometheus.Client.HttpRequestDurations

Installation

dotnet add package Prometheus.Client.HttpRequestDurations

Use

There are Examples

app.UsePrometheusRequestDurations(q =>
{
    q.IncludePath = true;
    q.IncludeMethod = true;
    q.IgnoreRoutesConcrete = new[] // Ignore some concrete routes
    {
        "/favicon.ico",
        "/robots.txt",
        "/"
    };
    q.IgnoreRoutesStartWith = new[]
    {
        "/swagger" // Ignore '/swagger/*'
    };
    q.CustomNormalizePath = new Dictionary<Regex, string>
    {
        { new Regex(@"\/[0-9]{1,}(?![a-z])"), "/id" } // Replace 'int' in Route
    };
});

Contribute

Contributions to the package are always welcome!

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's git repository.

License

All contents of this package are licensed under the MIT license.

prom-client-httprequestdurations's Issues

Controller name as metric label as option with .UsePrometheusRequestDurations()

We are migrating our applications from Prometheus-net to Prometheus.Client.

Prometheus-net had an extension method to IApplicationBuilder called UseHttpMetrics(). With the implementation in Prometheus.Client.HttpRequestDurations, I have been unable to identify a way to incorporate the controller name as a label in the metric. We really need this as if we use the path instead -- we end up with significant label explosion due to many parameters that are inorporated into our api route paths.

Is there an existing way to get 'Controller' name as a label? and if not, is this something that could be added?

Add "IgnoreRoutesNotStartingWith" or alternative

Quite often services using convention '/api/...' to avoid conflicts with routes and for other reasons. It'll be beneficial to have some way of telling the framework to ignore all routes which don't match the convention.

Measure requests to Prometheus endpoint

Measure requests to Prometheus endpoint so that it is included, because from what I'm seeing it isn't.

Would allow us to understand how fast we can serve metrics.

Define own buckets

Hi,

thanks for this tool! Would it be please possible to implement own bucket sizes to Histogram? Histogram supports this operation so it shouldn't be complicated (Metrics.CreateHistogram("my_histogram", "help text", buckets: new[] { 0, 0.2, 0.4, 0.6, 0.8, 0.9 });).

Thanks.

Martin

Path Normalization

Add 'Path Normalization' with regex.

Dirty version: https://github.com/PrometheusClientNet/Prometheus.Client.HttpRequestDurations/pull/1/files

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

This repository currently has no open or pending branches.

Detected dependencies

github-actions

.github/workflows/automerge.yml

.github/workflows/ci.yml

nuget

Directory.Build.props

• StyleCop.Analyzers 1.1.118
• Microsoft.SourceLink.GitHub 8.0.0

src/Prometheus.Client.HttpRequestDurations.csproj

• Prometheus.Client 5.2.0

tests/Prometheus.Client.HttpRequestDurations.Tests.csproj

• xunit.runner.visualstudio 2.8.0
• xunit 2.8.0
• coverlet.msbuild 6.0.2
• coverlet.collector 6.0.2
• Microsoft.NET.Test.Sdk 17.9.0

---

• Check this box to trigger a request for Renovate to run again on this repository

Custom Labels

Add custom labels for all metrics