bump 6.3.5

Describes httpDurationMetricName option on README

Makefile

@@ -1,7 +1,7 @@
 .PHONY: coverage
 
 test:
-	./node_modules/jasme/run.js
+	npm test
 lint:
 	node_modules/eslint/bin/eslint.js src
 	node_modules/.bin/dtslint types

README.md

@@ -53,6 +53,7 @@ Which labels to include in `http_request_duration_seconds` metric:
 * **metricsPath**: replace the `/metrics` route with a **regex** or exact **string**. Note: it is highly recommended to just stick to the default
 * **metricType**: histogram/summary selection. See more details below
 * **bypass**: function taking express request as an argument and determines whether the given request should be excluded in the metrics, default: **() => false**
+* **httpDurationMetricName**: Allows you change the name of HTTP duration metric, default: **`http_request_duration_seconds`**.
 
 ### metricType option ###
 

advanced-example.js

@@ -19,7 +19,8 @@ const bundle = promBundle({
   urlValueParser: {
     minHexLength: 5,
     extraMasks: [
-      "^[0-9]+\\.[0-9]+\\.[0-9]+$" // replace dot-separated dates with #val
+      "^[0-9]+\\.[0-9]+\\.[0-9]+$", // replace dot-separated dates with #val, (regex as string)
+      /^[0-9]+\-[0-9]+\-[0-9]+$/ // replace dash-separated dates with #val (actual regex)
     ]
   },
   normalizePath: [

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "express-prom-bundle",
-  "version": "6.3.2",
+  "version": "6.3.5",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-prom-bundle",
-  "version": "6.3.2",
+  "version": "6.3.5",
   "description": "express middleware with popular prometheus metrics in one bundle",
   "main": "src/index.js",
   "keywords": [
@@ -16,7 +16,7 @@
   ],
   "types": "types",
   "scripts": {
-    "test": "node_modules/jasme/run.js",
+    "test": "NODE_ENV=test node_modules/jasme/run.js",
     "lint": "eslint src",
     "coverage": "make coverage",
     "dtslint": "dtslint types",

spec/index.spec.js

@@ -409,6 +409,27 @@ describe('index', () => {
       });
   });
 
+  it('handles errors in collectors', done => {
+    const app = express();
+    const instance = bundle({});
+    app.use(instance);
+
+    new promClient.Gauge({
+      name: 'kaboom',
+      help: 'this metric explodes',
+      collect() {
+        throw new Error('kaboom!');
+      }
+    });
+
+    // the error will NOT be displayed if NODE_ENV=test (as defined in package.json)
+
+    supertest(app)
+      .get('/metrics')
+      .expect(500)
+      .end((err) => done(err));
+  });
+
   it('customLabels={foo: "bar"} adds foo="bar" label to metrics', done => {
     const app = express();
     const instance = bundle({

src/index.js

@@ -140,17 +140,20 @@ function main(opts) {
   }
 
   const metricsMiddleware = function(req, res, next) {
-    res.writeHead(200, {'Content-Type': 'text/plain'});
+    const sendSuccesss = (output) => {
+      res.writeHead(200, {'Content-Type': 'text/plain'});
+      res.end(output);
+    };
 
     const metricsResponse = opts.promRegistry.metrics();
     // starting from prom-client@13 .metrics() returns a Promise
     if (metricsResponse.then) {
       metricsResponse
-        .then(output => res.end(output))
+        .then(output => sendSuccesss(output))
         .catch(err => next(err));
     } else {
       // compatibility fallback for previous versions of prom-client@<=12
-      res.end(metricsResponse);
+      sendSuccesss(metricsResponse);
     }
   };
 
@@ -161,7 +164,7 @@ function main(opts) {
     const path = req.originalUrl || req.url; // originalUrl gets lost in koa-connect?
 
     if (opts.autoregister && path.match(metricsMatch)) {
-      return metricsMiddleware(req, res);
+      return metricsMiddleware(req, res, next);
     }
 
     // bypass() is checked only after /metrics was processed

types/index.d.ts

@@ -43,8 +43,8 @@ declare namespace express_prom_bundle {
     urlValueParser?: {
       minHexLength?: number;
       minBase64Length?: number;
-      replaceMasks?: string[];
-      extraMasks?: string[];
+      replaceMasks?: Array<RegExp | string>;
+      extraMasks?: Array<RegExp | string>;
     };
   }