bump 5.1.2

typedefs: normalizePath should return a string

.npmignore

@@ -1,8 +0,0 @@
-advanced-example.js
-docker-compose.yml
-spec
-.travis.yml
-.eslintrc
-coverage
-.vscode
-Makefile

README.md

@@ -51,8 +51,23 @@ Which labels to include in `http_request_duration_seconds` metric:
   Most useful together with **transformLabels** callback, otherwise it's better to use native Prometheus relabeling.
 * **includeUp**: include an auxiliary "up"-metric which always returns 1, default: **true**
 * **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
 
-Extra transformation callbacks:
+### metricType option ###
+
+Two metric types are supported for `http_request_duration_seconds` metric:
+* [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) (default)
+* [summary](https://prometheus.io/docs/concepts/metric_types/#summary)
+
+Additional options for **histogram**:
+* **buckets**: buckets used for the `http_request_duration_seconds` histogram
+
+Additional options for **summary**:
+* **percentiles**: percentiles used for `http_request_duration_seconds` summary
+* **ageBuckets**: ageBuckets configures how many buckets we have in our sliding window for the summary
+* **maxAgeSeconds**: the maxAgeSeconds will tell how old a bucket can be before it is reset
+
+### Transformation callbacks ###
 
 * **normalizePath**: `function(req)`  or `Array`
   * if function is provided, then it should generate path value from express `req`
@@ -64,14 +79,8 @@ Extra transformation callbacks:
 * **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**
 
-Metric type:
+### Other options ###
 
-* **metricType**: two metric types are supported for `http_request_duration_seconds` metric: [histogram](https://prometheus.io/docs/concepts/metric_types/#histogram) and [summary](https://prometheus.io/docs/concepts/metric_types/#summary),  default: **histogram**
-
-Other options:
-
-* **buckets**: buckets used for `http_request_duration_seconds` histogram
-* **percentiles**: percentiles used for `http_request_duration_seconds` summary
 * **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,

index.d.ts

@@ -0,0 +1,45 @@
+import * as express from "express";
+import { DefaultMetricsCollectorConfiguration } from "prom-client";
+
+type NormalizePathRegexs = [string, string];
+
+interface Labels {
+  [key: string]: string | number;
+}
+
+interface Opts {
+  autoregister?: boolean;
+  buckets?: [number];
+
+  includeStatusCode?: boolean;
+  includeMethod?: boolean;
+  includePath?: boolean;
+  includeUp?: boolean;
+
+  metricType?: "summary" | "histogram";
+  metricsPath?: string;
+  promClient?: DefaultMetricsCollectorConfiguration;
+  normalizePath?: NormalizePathRegexs;
+  formatStatusCode?: (res: express.Response) => number | string;
+
+  transformLabels: (
+    labels: Labels,
+    req: express.Request,
+    res: express.Response
+  ) => Labels;
+
+  // https://github.com/disjunction/url-value-parser#options
+  urlValueParser?: {
+    minHexLength?: number;
+    minBase64Length?: number;
+    replaceMasks?: string[];
+    extraMasks?: string[];
+  };
+}
+
+export function normalizePath(
+  req: express.Request,
+  opts?: { normalizePath?: NormalizePathRegexs }
+): string;
+
+export default function(opts: Opts): express.RequestHandler;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-prom-bundle",
-  "version": "5.0.2",
+  "version": "5.1.2",
   "description": "express middleware with popular prometheus metrics in one bundle",
   "main": "src/index.js",
   "keywords": [
@@ -10,6 +10,10 @@
     "path",
     "method"
   ],
+  "files": [
+    "src",
+    "index.d.ts"
+  ],
   "scripts": {
     "test": "node_modules/jasme/run.js",
     "coverage": "make coverage"

spec/index.spec.js

@@ -472,7 +472,10 @@ describe('index', () => {
       const agent = supertest(app);
 
       // create a fake worker, which would not respond in time
-      cluster.workers = [{send: () => {}}];
+      cluster.workers = [{
+        isConnected: () => true,
+        send: () => {}
+      }];
 
       const errorSpy = spyOn(console, 'error'); // mute console.error
 

src/index.js

@@ -90,7 +90,9 @@ function main(opts) {
         name: httpMetricName,
         help: 'duration summary of http responses labeled with: ' + labels.join(', '),
         labelNames: labels,
-        percentiles: opts.percentiles || [0.5, 0.75, 0.95, 0.98, 0.99, 0.999]
+        percentiles: opts.percentiles || [0.5, 0.75, 0.95, 0.98, 0.99, 0.999],
+        maxAgeSeconds:  opts.maxAgeSeconds,
+        ageBuckets: opts.ageBuckets
       });
     } else if (opts.metricType === 'histogram' || !opts.metricType) {
       return new promClient.Histogram({