BreizhHardware/express-prom-bundle
1
0
Fork 0
mirror of https://github.com/BreizhHardware/express-prom-bundle.git synced 2026-01-18 16:27:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

add README docs for urlPathReplacement, see #75

Browse Source
This commit is contained in:
Konstantin Pogorelov
2021-08-17 10:11:10 +03:00
parent 068ed93a61
commit 77b02c7302
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -80,10 +80,11 @@ Additional options for **summary**:
See the [docs](https://github.com/disjunction/url-value-parser) of url-value-parser module for details.
* **formatStatusCode**: `function(res)` producing final status code from express `res` object, e.g. you can combine `200`, `201` and `204` to just `2xx`.
* **transformLabels**: `function(labels, req, res)` transforms the **labels** object, e.g. setting dynamic values to **customLabels**
* **urlPathReplacement**: replacement string for the values (default: "#val")
### Other options ###
* **autoregister**: if `/metrics` endpoint should be registered. (Default: **true**)
* **autoregister**: if `/metrics` endpoint should be registered (default: **true**)
* **promClient**: options for promClient startup, e.g. **collectDefaultMetrics**. This option was added
to keep `express-prom-bundle` runnable using confit (e.g. with kraken.js) without writing any JS code,
see [advanced example](https://github.com/jochen-schweizer/express-prom-bundle/blob/master/advanced-example.js)