From a7690cb69646b24d0709db388a01c43eaf2a23d4 Mon Sep 17 00:00:00 2001 From: bunny-therapist Date: Mon, 22 Jan 2024 20:41:54 +0100 Subject: [PATCH] Update README for skip_paths --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b4ec779..3fa61f8 100644 --- a/README.md +++ b/README.md @@ -84,7 +84,7 @@ retrieves a value from the `Request` object. [See below](#labels) for examples. `buckets`: accepts an optional list of numbers to use as histogram buckets. The default value is `None`, which will cause the library to fall back on the Prometheus defaults (currently `[0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1.0, 2.5, 5.0, 7.5, 10.0]`). -`skip_paths`: accepts an optional list of paths that will not collect metrics. The default value is `None`, which will cause the library to collect metrics on every requested path. This option is useful to avoid collecting metrics on health check, readiness or liveness probe endpoints. +`skip_paths`: accepts an optional list of paths - or regular expressions for paths - that will not collect metrics. The default value is `None`, which will cause the library to collect metrics on every requested path. This option is useful to avoid collecting metrics on health check, readiness or liveness probe endpoints. `skip_methods`: accepts an optional list of methods that will not collect metrics. The default value is `None`, which will cause the library to collect request metrics with each method. This option is useful to avoid collecting metrics on requests related to the communication description for endpoints.