prometheus-gc-stats
Advanced tools
Comparing version 0.5.0 to 0.5.1
{ | ||
"name": "prometheus-gc-stats", | ||
"version": "0.5.0", | ||
"version": "0.5.1", | ||
"description": "Report Garbage Collection stats using Prometheus", | ||
@@ -10,7 +10,3 @@ "main": "index.js", | ||
"scripts": { | ||
"compile": "babel gc-metrics.js -o index.js", | ||
"postcompile": "prettier --write index.js", | ||
"lint": "eslint .", | ||
"prepublishOnly": "npm run compile", | ||
"postpublish": "git push --follow-tags", | ||
"pretest": "npm run lint", | ||
@@ -40,10 +36,10 @@ "test": "jest" | ||
"peerDependencies": { | ||
"prom-client": ">= 10 < 11" | ||
"prom-client": ">= 10 < 12" | ||
}, | ||
"devDependencies": { | ||
"eslint": "^3.9.1", | ||
"eslint-config-simenb-base": "^12.0.0", | ||
"eslint": "^4.3.0", | ||
"eslint-config-simenb-base": "^14.0.0", | ||
"eslint-config-simenb-jest": "^2.0.0", | ||
"eslint-config-simenb-node": "^0.4.9", | ||
"jest": "^20.0.4", | ||
"jest": "^22.1.4", | ||
"prettier": "^1.4.4", | ||
@@ -50,0 +46,0 @@ "prom-client": "^10.0.0" |
# prometheus-gc-stats | ||
> Report Garbage Collection stats using Prometheus | ||
@@ -21,4 +22,15 @@ | ||
The exported function takes a single parameter, which is a registry. If provided, and the version of prom-client you use support it, that is | ||
the registry which the metrics will register to. | ||
the registry which the metrics will register to. If no registry is provided it will use the default one provided by `prom-client`. | ||
Example: | ||
```js | ||
const prometheus = require('prom-client'); | ||
const gcStats = require('prometheus-gc-stats'); | ||
prometheus.collectDefaultMetrics(); | ||
const startGcStats = gcStats(prometheus.register); // gcStats() would have the same effect in this case | ||
startGcStats(); | ||
``` | ||
### `gc-stats` | ||
@@ -41,3 +53,2 @@ | ||
[circle-ci-url]: https://circleci.com/gh/SimenB/node-prometheus-gc-stats | ||
@@ -56,2 +67,2 @@ [circle-ci-image]: https://circleci.com/gh/SimenB/node-prometheus-gc-stats/tree/master.svg?style=shield&circle-token=05b6e173edee3b1494b0370d5d3caea00ad358a3 | ||
[greenkeeper-url]: greenkeeper-url | ||
[greenkeeper-image]:https://badges.greenkeeper.io/SimenB/node-prometheus-gc-stats.svg | ||
[greenkeeper-image]: https://badges.greenkeeper.io/SimenB/node-prometheus-gc-stats.svg |
6569
66