@loopback/metrics 0.5.2 → 0.7.1

package/CHANGELOG.md

@@ -3,6 +3,57 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.7.1](https://github.com/strongloop/loopback-next/compare/@loopback/metrics@0.7.0...@loopback/metrics@0.7.1) (2021-04-06)
+
+**Note:** Version bump only for package @loopback/metrics
+
+
+
+
+
+# [0.7.0](https://github.com/strongloop/loopback-next/compare/@loopback/metrics@0.6.1...@loopback/metrics@0.7.0) (2021-03-18)
+
+
+### Bug Fixes
+
+* **metrics:** update to be compatible with prom-client 13.x ([967f018](https://github.com/strongloop/loopback-next/commit/967f018744a4eb07c5a6c2c827bea956e0488f7b))
+
+
+### Features
+
+* update package-lock.json to v2 consistently ([dfc3fbd](https://github.com/strongloop/loopback-next/commit/dfc3fbdae0c9ca9f34c64154a471bef22d5ac6b7))
+
+
+
+
+
+## [0.6.1](https://github.com/strongloop/loopback-next/compare/@loopback/metrics@0.6.0...@loopback/metrics@0.6.1) (2021-02-09)
+
+**Note:** Version bump only for package @loopback/metrics
+
+
+
+
+
+# [0.6.0](https://github.com/strongloop/loopback-next/compare/@loopback/metrics@0.5.2...@loopback/metrics@0.6.0) (2021-01-21)
+
+
+### Bug Fixes
+
+* **metrics:** fix error thrown by interceptor if invoked by proxy ([2fd2da2](https://github.com/strongloop/loopback-next/commit/2fd2da2a5664651675a7510910a674706d04d5f8))
+* **metrics:** use path pattern instead of raw path in path labels ([80a07bc](https://github.com/strongloop/loopback-next/commit/80a07bcb624fd60a72b7537d285723de3a7c04f8))
+
+
+### Features
+
+* **metrics:** add new Pushgateway options ([6d73fff](https://github.com/strongloop/loopback-next/commit/6d73fff0e19eb1d5646878d77c38463422607c22))
+* **metrics:** add option to configure static default labels ([8bce9e8](https://github.com/strongloop/loopback-next/commit/8bce9e81c916051633486dff2f4aa1af643ca15c))
+* **metrics:** additional method invocation labels ([cb3b9a5](https://github.com/strongloop/loopback-next/commit/cb3b9a58683a5cd9c707e77b6896eb5bb4de4db2))
+
+
+
+
+
 ## [0.5.2](https://github.com/strongloop/loopback-next/compare/@loopback/metrics@0.5.1...@loopback/metrics@0.5.2) (2020-12-07)
 
 **Note:** Version bump only for package @loopback/metrics

package/README.md

@@ -44,9 +44,16 @@ this.configure(MetricsBindings.COMPONENT).to({
   defaultMetrics: {
     timeout: 5000,
   },
+  defaultLabels: {
+    service: 'api',
+    version: '1.0.0',
+  },
 });
 ```
 
+{% include note.html content="this.configure() must be called before
+this.component() to take effect." %}
+
 It also has to be noted, that by default the OpenAPI spec is disabled and
 therefore the metrics endpoint will not be visible in the API explorer. The spec
 can be enabled by setting `openApiSpec` to `true`.
@@ -70,12 +77,12 @@ There are three types of metrics being collected by this component:
 
 Prometheus supports two modes to collect metrics:
 
-- pull - scraping from metrics http endpoint exposed by the system being
-  monitored
-- push - pushing metrics from the system being monitored to a push gateway
-
-See
-https://prometheus.io/docs/introduction/faq/#why-do-you-pull-rather-than-push
+- **pull** - scraping from metrics http endpoint exposed by the system being
+  monitored. This is the usual mode of operation. See
+  [Why do you pull rather than push?](https://prometheus.io/docs/introduction/faq/#why-do-you-pull-rather-than-push)
+- **push** - pushing metrics from the system being monitored to a push gateway.
+  Generally used for ephemeral jobs - see
+  [When to use the Pushgateway](https://prometheus.io/docs/practices/pushing/)
 
 ## Try it out
 
@@ -172,13 +179,37 @@ nodejs_heap_space_size_available_bytes{space="new_large_object"} 1047952 1564508
 nodejs_version_info{version="v12.4.0",major="12",minor="4",patch="0"} 1
 # HELP loopback_invocation_duration_seconds method invocation
 # TYPE loopback_invocation_duration_seconds gauge
+loopback_invocation_duration_seconds{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002056
 # HELP loopback_invocation_duration_histogram method invocation histogram
 # TYPE loopback_invocation_duration_histogram histogram
-# HELP loopback_invocation_total method invocation counts
+loopback_invocation_duration_histogram_bucket{le="0.005",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.01",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.025",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.05",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.1",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.25",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="0.5",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="1",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="2.5",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="5",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="10",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_bucket{le="+Inf",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+loopback_invocation_duration_histogram_sum{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002112
+loopback_invocation_duration_histogram_count{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
+# HELP loopback_invocation_total method invocation count
 # TYPE loopback_invocation_total counter
-loopback_invocation_total 1
+loopback_invocation_total{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
 # HELP loopback_invocation_duration_summary method invocation summary
 # TYPE loopback_invocation_duration_summary summary
+loopback_invocation_duration_summary{quantile="0.01",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.05",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.5",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.9",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.95",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.99",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary{quantile="0.999",targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary_sum{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 0.0002363
+loopback_invocation_duration_summary_count{targetName="MockController.prototype.success",method="GET",path="/success",statusCode="204"} 1
 </pre>
 
 </details>

package/dist/controllers/metrics.controller.js

@@ -13,7 +13,7 @@ const types_1 = require("../types");
 /**
  * OpenAPI definition of metrics response
  */
-const metricsResponse = {
+const METRICS_RESPONSE = {
     description: 'Metrics Response',
     content: {
         'text/plain': {
@@ -26,30 +26,31 @@ const metricsResponse = {
 /**
  * OpenAPI spec for metrics endpoint
  */
-const metricsSpec = {
+const METRICS_SPEC = {
     responses: {
-        '200': metricsResponse,
+        '200': METRICS_RESPONSE,
     },
 };
 /**
  * OpenAPI spec to hide endpoints
  */
-const hiddenSpec = {
+const HIDDEN_SPEC = {
     responses: {},
     'x-visibility': 'undocumented',
 };
 function metricsControllerFactory(options = types_1.DEFAULT_METRICS_OPTIONS) {
     var _a, _b;
     const basePath = (_b = (_a = options.endpoint) === null || _a === void 0 ? void 0 : _a.basePath) !== null && _b !== void 0 ? _b : '/metrics';
-    const spec = options.openApiSpec ? metricsSpec : hiddenSpec;
+    const spec = options.openApiSpec ? METRICS_SPEC : HIDDEN_SPEC;
     /**
      * Controller for metrics endpoint
      */
     let MetricsController = class MetricsController {
-        report(res) {
+        async report(res) {
             // Set the content type from the register
             res.contentType(prom_client_1.register.contentType);
-            res.send(prom_client_1.register.metrics());
+            const data = await prom_client_1.register.metrics();
+            res.send(data);
             return res;
         }
     };
@@ -58,7 +59,7 @@ function metricsControllerFactory(options = types_1.DEFAULT_METRICS_OPTIONS) {
         tslib_1.__param(0, core_1.inject(rest_1.RestBindings.Http.RESPONSE)),
         tslib_1.__metadata("design:type", Function),
         tslib_1.__metadata("design:paramtypes", [Object]),
-        tslib_1.__metadata("design:returntype", void 0)
+        tslib_1.__metadata("design:returntype", Promise)
     ], MetricsController.prototype, "report", null);
     MetricsController = tslib_1.__decorate([
         core_1.injectable({ scope: core_1.BindingScope.SINGLETON })

package/dist/controllers/metrics.controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.controller.js","sourceRoot":"","sources":["../../src/controllers/metrics.controller.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAA6E;AAC7E,yCAMwB;AACxB,6CAAqC;AACrC,oCAAiE;AAEjE;;GAEG;AACH,MAAM,eAAe,GAAmB;IACtC,WAAW,EAAE,kBAAkB;IAC/B,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAoB;IACnC,SAAS,EAAE;QACT,KAAK,EAAE,eAAe;KACvB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,UAAU,GAAoB;IAClC,SAAS,EAAE,EAAE;IACb,cAAc,EAAE,cAAc;CAC/B,CAAC;AAEF,SAAgB,wBAAwB,CACtC,UAA0B,+BAAuB;;IAEjD,MAAM,QAAQ,eAAG,OAAO,CAAC,QAAQ,0CAAE,QAAQ,mCAAI,UAAU,CAAC;IAC1D,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,UAAU,CAAC;IAE5D;;OAEG;IAEH,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;QAErB,MAAM,CAAqC,GAAa;YACtD,yCAAyC;YACzC,GAAG,CAAC,WAAW,CAAC,sBAAQ,CAAC,WAAW,CAAC,CAAC;YACtC,GAAG,CAAC,IAAI,CAAC,sBAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7B,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAA;IANC;QADC,UAAG,CAAC,QAAQ,EAAE,IAAI,CAAC;QACZ,mBAAA,aAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;mDAKzC;IAPG,iBAAiB;QADtB,iBAAU,CAAC,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;OACtC,iBAAiB,CAQtB;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AArBD,4DAqBC"}
+{"version":3,"file":"metrics.controller.js","sourceRoot":"","sources":["../../src/controllers/metrics.controller.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAA6E;AAC7E,yCAMwB;AACxB,6CAAqC;AACrC,oCAAiE;AAEjE;;GAEG;AACH,MAAM,gBAAgB,GAAmB;IACvC,WAAW,EAAE,kBAAkB;IAC/B,OAAO,EAAE;QACP,YAAY,EAAE;YACZ,MAAM,EAAE;gBACN,IAAI,EAAE,QAAQ;aACf;SACF;KACF;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,YAAY,GAAoB;IACpC,SAAS,EAAE;QACT,KAAK,EAAE,gBAAgB;KACxB;CACF,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,GAAoB;IACnC,SAAS,EAAE,EAAE;IACb,cAAc,EAAE,cAAc;CAC/B,CAAC;AAEF,SAAgB,wBAAwB,CACtC,UAA0B,+BAAuB;;IAEjD,MAAM,QAAQ,GAAG,MAAA,MAAA,OAAO,CAAC,QAAQ,0CAAE,QAAQ,mCAAI,UAAU,CAAC;IAC1D,MAAM,IAAI,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,WAAW,CAAC;IAE9D;;OAEG;IAEH,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;QAErB,KAAK,CAAC,MAAM,CAAqC,GAAa;YAC5D,yCAAyC;YACzC,GAAG,CAAC,WAAW,CAAC,sBAAQ,CAAC,WAAW,CAAC,CAAC;YACtC,MAAM,IAAI,GAAG,MAAM,sBAAQ,CAAC,OAAO,EAAE,CAAC;YACtC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACf,OAAO,GAAG,CAAC;QACb,CAAC;KACF,CAAA;IAPC;QADC,UAAG,CAAC,QAAQ,EAAE,IAAI,CAAC;QACN,mBAAA,aAAM,CAAC,mBAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;mDAM/C;IARG,iBAAiB;QADtB,iBAAU,CAAC,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;OACtC,iBAAiB,CAStB;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAtBD,4DAsBC"}

package/dist/interceptors/metrics.interceptor.js

@@ -9,6 +9,7 @@ exports.MetricsInterceptor = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@loopback/core");
 const prom_client_1 = require("prom-client");
+const labelNames = ['targetName', 'method', 'path', 'statusCode'];
 /**
  * This interceptor captures metrics for method invocations,
  * excluding sequence actions and middleware executed before
@@ -26,22 +27,22 @@ let MetricsInterceptor = MetricsInterceptor_1 = class MetricsInterceptor {
         this.gauge = new prom_client_1.Gauge({
             name: 'loopback_invocation_duration_seconds',
             help: 'method invocation',
-            labelNames: ['targetName'],
+            labelNames,
         });
         this.histogram = new prom_client_1.Histogram({
             name: 'loopback_invocation_duration_histogram',
             help: 'method invocation histogram',
-            labelNames: ['targetName'],
+            labelNames,
         });
         this.counter = new prom_client_1.Counter({
             name: 'loopback_invocation_total',
-            help: 'method invocation counts',
-            labelNames: ['targetName'],
+            help: 'method invocation count',
+            labelNames,
         });
         this.summary = new prom_client_1.Summary({
             name: 'loopback_invocation_duration_summary',
             help: 'method invocation summary',
-            labelNames: ['targetName'],
+            labelNames,
         });
     }
     value() {
@@ -49,23 +50,37 @@ let MetricsInterceptor = MetricsInterceptor_1 = class MetricsInterceptor {
     }
     async intercept(invocationCtx, next) {
         MetricsInterceptor_1.setup();
-        const endGauge = MetricsInterceptor_1.gauge.startTimer({
+        const { source, parent } = invocationCtx;
+        const labelValues = {
             targetName: invocationCtx.targetName,
-        });
-        const endHistogram = MetricsInterceptor_1.histogram.startTimer({
-            targetName: invocationCtx.targetName,
-        });
-        const endSummary = MetricsInterceptor_1.summary.startTimer({
-            targetName: invocationCtx.targetName,
-        });
+        };
+        if (isRouteSource(source)) {
+            labelValues.method = getRequestMethod(source);
+            labelValues.path = getPathPattern(source);
+        }
+        const endGauge = MetricsInterceptor_1.gauge.startTimer();
+        const endHistogram = MetricsInterceptor_1.histogram.startTimer();
+        const endSummary = MetricsInterceptor_1.summary.startTimer();
         try {
-            MetricsInterceptor_1.counter.inc();
-            return await next();
+            const result = await next();
+            if (isRouteSource(source)) {
+                labelValues.statusCode = getStatusCodeFromResponse(
+                // parent context will be request context if invocation source is route
+                parent.response, result);
+            }
+            return result;
+        }
+        catch (err) {
+            if (isRouteSource(source)) {
+                labelValues.statusCode = getStatusCodeFromError(err);
+            }
+            throw err;
         }
         finally {
-            endGauge();
-            endHistogram();
-            endSummary();
+            MetricsInterceptor_1.counter.inc(labelValues);
+            endGauge(labelValues);
+            endHistogram(labelValues);
+            endSummary(labelValues);
         }
     }
 };
@@ -74,4 +89,30 @@ MetricsInterceptor = MetricsInterceptor_1 = tslib_1.__decorate([
     tslib_1.__metadata("design:paramtypes", [])
 ], MetricsInterceptor);
 exports.MetricsInterceptor = MetricsInterceptor;
+function getPathPattern(source) {
+    // make sure to use path pattern instead of raw path
+    // this is important since paths can contain unbounded sets of values
+    // such as IDs which would create a new time series for each unique value
+    return source.value.path;
+}
+function getRequestMethod(source) {
+    // request methods should be all-uppercase
+    return source.value.verb.toUpperCase();
+}
+function getStatusCodeFromResponse(response, result) {
+    // interceptors are invoked before result is written to response,
+    // the status code for 200 responses without a result should be 204
+    const noContent = response.statusCode === 200 && result === undefined;
+    return noContent ? 204 : response.statusCode;
+}
+function getStatusCodeFromError(err) {
+    var _a, _b;
+    // interceptors are invoked before error is written to response,
+    // it is required to retrieve the status code from the error
+    const notFound = err.code === 'ENTITY_NOT_FOUND';
+    return (_b = (_a = err.statusCode) !== null && _a !== void 0 ? _a : err.status) !== null && _b !== void 0 ? _b : (notFound ? 404 : 500);
+}
+function isRouteSource(source) {
+    return (source === null || source === void 0 ? void 0 : source.type) === 'route';
+}
 //# sourceMappingURL=metrics.interceptor.js.map

package/dist/interceptors/metrics.interceptor.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.interceptor.js","sourceRoot":"","sources":["../../src/interceptors/metrics.interceptor.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,yCAQwB;AACxB,6CAAyE;AAEzE;;;;;GAKG;AAEH,IAAa,kBAAkB,0BAA/B,MAAa,kBAAkB;IA0C7B,gBAAe,CAAC;IAjCR,MAAM,CAAC,KAAK;QAClB,mCAAmC;QACnC,IACE,IAAI,CAAC,KAAK;YACV,sBAAQ,CAAC,eAAe,CAAC,sCAAsC,CAAC;YAEhE,OAAO;QACT,oEAAoE;QACpE,IAAI,CAAC,KAAK,GAAG,IAAI,mBAAK,CAAC;YACrB,IAAI,EAAE,sCAAsC;YAC5C,IAAI,EAAE,mBAAmB;YACzB,UAAU,EAAE,CAAC,YAAY,CAAC;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,IAAI,uBAAS,CAAC;YAC7B,IAAI,EAAE,wCAAwC;YAC9C,IAAI,EAAE,6BAA6B;YACnC,UAAU,EAAE,CAAC,YAAY,CAAC;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAO,CAAC;YACzB,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,0BAA0B;YAChC,UAAU,EAAE,CAAC,YAAY,CAAC;SAC3B,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAO,CAAC;YACzB,IAAI,EAAE,sCAAsC;YAC5C,IAAI,EAAE,2BAA2B;YACjC,UAAU,EAAE,CAAC,YAAY,CAAC;SAC3B,CAAC,CAAC;IACL,CAAC;IAID,KAAK;QACH,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,SAAS,CACb,aAAgC,EAChC,IAA6B;QAE7B,oBAAkB,CAAC,KAAK,EAAE,CAAC;QAC3B,MAAM,QAAQ,GAAG,oBAAkB,CAAC,KAAK,CAAC,UAAU,CAAC;YACnD,UAAU,EAAE,aAAa,CAAC,UAAU;SACrC,CAAC,CAAC;QACH,MAAM,YAAY,GAAG,oBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC;YAC3D,UAAU,EAAE,aAAa,CAAC,UAAU;SACrC,CAAC,CAAC;QACH,MAAM,UAAU,GAAG,oBAAkB,CAAC,OAAO,CAAC,UAAU,CAAC;YACvD,UAAU,EAAE,aAAa,CAAC,UAAU;SACrC,CAAC,CAAC;QACH,IAAI;YACF,oBAAkB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,EAAE,CAAC;SACrB;gBAAS;YACR,QAAQ,EAAE,CAAC;YACX,YAAY,EAAE,CAAC;YACf,UAAU,EAAE,CAAC;SACd;IACH,CAAC;CACF,CAAA;AAvEY,kBAAkB;IAD9B,iBAAU,CAAC,0BAAmB,CAAC,SAAS,CAAC,EAAE,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;;GAC/D,kBAAkB,CAuE9B;AAvEY,gDAAkB"}
+{"version":3,"file":"metrics.interceptor.js","sourceRoot":"","sources":["../../src/interceptors/metrics.interceptor.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;;AAEhE,yCASwB;AAOxB,6CAOqB;AAIrB,MAAM,UAAU,GAAiB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;AAEhF;;;;;GAKG;AAEH,IAAa,kBAAkB,0BAA/B,MAAa,kBAAkB;IA0C7B,gBAAe,CAAC;IAjCR,MAAM,CAAC,KAAK;QAClB,mCAAmC;QACnC,IACE,IAAI,CAAC,KAAK;YACV,sBAAQ,CAAC,eAAe,CAAC,sCAAsC,CAAC;YAEhE,OAAO;QACT,oEAAoE;QACpE,IAAI,CAAC,KAAK,GAAG,IAAI,mBAAK,CAAC;YACrB,IAAI,EAAE,sCAAsC;YAC5C,IAAI,EAAE,mBAAmB;YACzB,UAAU;SACX,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,GAAG,IAAI,uBAAS,CAAC;YAC7B,IAAI,EAAE,wCAAwC;YAC9C,IAAI,EAAE,6BAA6B;YACnC,UAAU;SACX,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAO,CAAC;YACzB,IAAI,EAAE,2BAA2B;YACjC,IAAI,EAAE,yBAAyB;YAC/B,UAAU;SACX,CAAC,CAAC;QAEH,IAAI,CAAC,OAAO,GAAG,IAAI,qBAAO,CAAC;YACzB,IAAI,EAAE,sCAAsC;YAC5C,IAAI,EAAE,2BAA2B;YACjC,UAAU;SACX,CAAC,CAAC;IACL,CAAC;IAID,KAAK;QACH,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,CAAC,SAAS,CACb,aAAgC,EAChC,IAA6B;QAE7B,oBAAkB,CAAC,KAAK,EAAE,CAAC;QAC3B,MAAM,EAAC,MAAM,EAAE,MAAM,EAAC,GAAG,aAAa,CAAC;QACvC,MAAM,WAAW,GAA4B;YAC3C,UAAU,EAAE,aAAa,CAAC,UAAU;SACrC,CAAC;QACF,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;YACzB,WAAW,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;YAC9C,WAAW,CAAC,IAAI,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;SAC3C;QACD,MAAM,QAAQ,GAAG,oBAAkB,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;QACvD,MAAM,YAAY,GAAG,oBAAkB,CAAC,SAAS,CAAC,UAAU,EAAE,CAAC;QAC/D,MAAM,UAAU,GAAG,oBAAkB,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;QAC3D,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,EAAE,CAAC;YAC5B,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;gBACzB,WAAW,CAAC,UAAU,GAAG,yBAAyB;gBAChD,uEAAuE;gBACtE,MAAyB,CAAC,QAAQ,EACnC,MAAM,CACP,CAAC;aACH;YACD,OAAO,MAAM,CAAC;SACf;QAAC,OAAO,GAAG,EAAE;YACZ,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE;gBACzB,WAAW,CAAC,UAAU,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC;aACtD;YACD,MAAM,GAAG,CAAC;SACX;gBAAS;YACR,oBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC5C,QAAQ,CAAC,WAAW,CAAC,CAAC;YACtB,YAAY,CAAC,WAAW,CAAC,CAAC;YAC1B,UAAU,CAAC,WAAW,CAAC,CAAC;SACzB;IACH,CAAC;CACF,CAAA;AAtFY,kBAAkB;IAD9B,iBAAU,CAAC,0BAAmB,CAAC,SAAS,CAAC,EAAE,EAAC,KAAK,EAAE,mBAAY,CAAC,SAAS,EAAC,CAAC;;GAC/D,kBAAkB,CAsF9B;AAtFY,gDAAkB;AAwF/B,SAAS,cAAc,CAAC,MAAmB;IACzC,oDAAoD;IACpD,qEAAqE;IACrE,yEAAyE;IACzE,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;AAC3B,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAmB;IAC3C,0CAA0C;IAC1C,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;AACzC,CAAC;AAED,SAAS,yBAAyB,CAAC,QAAkB,EAAE,MAAgB;IACrE,iEAAiE;IACjE,mEAAmE;IACnE,MAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,KAAK,GAAG,IAAI,MAAM,KAAK,SAAS,CAAC;IACtE,OAAO,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC;AAC/C,CAAC;AAED,SAAS,sBAAsB,CAAC,GAAyB;;IACvD,gEAAgE;IAChE,4DAA4D;IAC5D,MAAM,QAAQ,GAAG,GAAG,CAAC,IAAI,KAAK,kBAAkB,CAAC;IACjD,OAAO,MAAA,MAAA,GAAG,CAAC,UAAU,mCAAI,GAAG,CAAC,MAAM,mCAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AAChE,CAAC;AAED,SAAS,aAAa,CAAC,MAAyB;IAC9C,OAAO,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,IAAI,MAAK,OAAO,CAAC;AAClC,CAAC"}

package/dist/metrics.component.js

@@ -7,6 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MetricsComponent = void 0;
 const tslib_1 = require("tslib");
 const core_1 = require("@loopback/core");
+const prom_client_1 = require("prom-client");
 const controllers_1 = require("./controllers");
 const interceptors_1 = require("./interceptors");
 const keys_1 = require("./keys");
@@ -32,6 +33,9 @@ let MetricsComponent = class MetricsComponent {
         if (options.endpoint && !options.endpoint.disabled) {
             this.application.controller(controllers_1.metricsControllerFactory(options));
         }
+        if (options.defaultLabels) {
+            prom_client_1.register.setDefaultLabels(options.defaultLabels);
+        }
     }
 };
 MetricsComponent = tslib_1.__decorate([

package/dist/metrics.component.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.component.js","sourceRoot":"","sources":["../src/metrics.component.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCASwB;AACxB,+CAAuD;AACvD,iDAAkD;AAClD,iCAAuC;AACvC,2CAAiE;AACjE,mCAA+E;AAE/E;;GAEG;AAEH,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAC3B,YAEU,WAAwB,EAEhC,gBAA+B,EAAE;QAFzB,gBAAW,GAAX,WAAW,CAAa;QAIhC,MAAM,OAAO,GAAmB;YAC9B,GAAG,+BAAuB;YAC1B,GAAG,aAAa;SACjB,CAAC;QACF,IAAI,OAAO,CAAC,cAAc,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE;YAC9D,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,2BAAe,CAAC,CAAC;SACrD;QACD,IAAI,OAAO,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE;YACxD,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,+BAAmB,CAAC,CAAC;SACzD;QACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,6BAAsB,CAAC,iCAAkB,CAAC,CAAC,CAAC;QACjE,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAClD,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,sCAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;SAChE;IACH,CAAC;CACF,CAAA;AAtBY,gBAAgB;IAD5B,iBAAU,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,kBAAW,CAAC,GAAG,CAAC,EAAE,sBAAe,CAAC,SAAS,EAAC,EAAC,CAAC;IAG9D,mBAAA,aAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzC,mBAAA,aAAM,EAAE,CAAA;6CADY,kBAAW;GAHvB,gBAAgB,CAsB5B;AAtBY,4CAAgB"}
+{"version":3,"file":"metrics.component.js","sourceRoot":"","sources":["../src/metrics.component.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCASwB;AACxB,6CAAqC;AACrC,+CAAuD;AACvD,iDAAkD;AAClD,iCAAuC;AACvC,2CAAiE;AACjE,mCAA+E;AAE/E;;GAEG;AAEH,IAAa,gBAAgB,GAA7B,MAAa,gBAAgB;IAC3B,YAEU,WAAwB,EAEhC,gBAA+B,EAAE;QAFzB,gBAAW,GAAX,WAAW,CAAa;QAIhC,MAAM,OAAO,GAAmB;YAC9B,GAAG,+BAAuB;YAC1B,GAAG,aAAa;SACjB,CAAC;QACF,IAAI,OAAO,CAAC,cAAc,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,QAAQ,EAAE;YAC9D,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,2BAAe,CAAC,CAAC;SACrD;QACD,IAAI,OAAO,CAAC,WAAW,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,EAAE;YACxD,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,+BAAmB,CAAC,CAAC;SACzD;QACD,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,6BAAsB,CAAC,iCAAkB,CAAC,CAAC,CAAC;QACjE,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAClD,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,sCAAwB,CAAC,OAAO,CAAC,CAAC,CAAC;SAChE;QACD,IAAI,OAAO,CAAC,aAAa,EAAE;YACzB,sBAAQ,CAAC,gBAAgB,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAClD;IACH,CAAC;CACF,CAAA;AAzBY,gBAAgB;IAD5B,iBAAU,CAAC,EAAC,IAAI,EAAE,EAAC,CAAC,kBAAW,CAAC,GAAG,CAAC,EAAE,sBAAe,CAAC,SAAS,EAAC,EAAC,CAAC;IAG9D,mBAAA,aAAM,CAAC,mBAAY,CAAC,oBAAoB,CAAC,CAAA;IAEzC,mBAAA,aAAM,EAAE,CAAA;6CADY,kBAAW;GAHvB,gBAAgB,CAyB5B;AAzBY,4CAAgB"}

package/dist/observers/metrics.push.observer.js

@@ -24,7 +24,17 @@ let MetricsPushObserver = class MetricsPushObserver {
             return;
         this.gateway = new prom_client_1.Pushgateway(gwConfig.url);
         this.interval = setInterval(() => {
-            this.gateway.pushAdd({ jobName: 'loopback' }, () => { });
+            var _a;
+            const params = {
+                jobName: (_a = gwConfig.jobName) !== null && _a !== void 0 ? _a : 'loopback',
+                groupings: gwConfig.groupingKey,
+            };
+            if (gwConfig.replaceAll) {
+                this.gateway.push(params, () => { });
+            }
+            else {
+                this.gateway.pushAdd(params, () => { });
+            }
         }, (_a = gwConfig.interval) !== null && _a !== void 0 ? _a : 5000);
     }
     stop() {

package/dist/observers/metrics.push.observer.js.map

@@ -1 +1 @@
-{"version":3,"file":"metrics.push.observer.js","sourceRoot":"","sources":["../../src/observers/metrics.push.observer.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAAyD;AACzD,6CAAwC;AACxC,kCAAwC;AACxC,oCAAiE;AAEjE;;GAEG;AACH,IAAa,mBAAmB,GAAhC,MAAa,mBAAmB;IAI9B,YAEU,UAA0B,+BAAuB;QAAjD,YAAO,GAAP,OAAO,CAA0C;IACxD,CAAC;IAEJ,KAAK;;QACH,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,yBAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;YAC/B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EAAC,OAAO,EAAE,UAAU,EAAC,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QACxD,CAAC,QAAE,QAAQ,CAAC,QAAQ,mCAAI,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;IACH,CAAC;CACF,CAAA;AAxBY,mBAAmB;IAK3B,mBAAA,aAAM,CAAC,EAAC,WAAW,EAAE,sBAAe,CAAC,SAAS,EAAC,CAAC,CAAA;;GALxC,mBAAmB,CAwB/B;AAxBY,kDAAmB"}
+{"version":3,"file":"metrics.push.observer.js","sourceRoot":"","sources":["../../src/observers/metrics.push.observer.ts"],"names":[],"mappings":";AAAA,iDAAiD;AACjD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;;AAEhE,yCAAyD;AACzD,6CAAwC;AACxC,kCAAwC;AACxC,oCAAiE;AAEjE;;GAEG;AACH,IAAa,mBAAmB,GAAhC,MAAa,mBAAmB;IAI9B,YAEU,UAA0B,+BAAuB;QAAjD,YAAO,GAAP,OAAO,CAA0C;IACxD,CAAC;IAEJ,KAAK;;QACH,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;QAC1C,IAAI,CAAC,QAAQ;YAAE,OAAO;QACtB,IAAI,CAAC,OAAO,GAAG,IAAI,yBAAW,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,GAAG,EAAE;;YAC/B,MAAM,MAAM,GAAG;gBACb,OAAO,EAAE,MAAA,QAAQ,CAAC,OAAO,mCAAI,UAAU;gBACvC,SAAS,EAAE,QAAQ,CAAC,WAAW;aAChC,CAAC;YACF,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACvB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;aACrC;iBAAM;gBACL,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;aACxC;QACH,CAAC,EAAE,MAAA,QAAQ,CAAC,QAAQ,mCAAI,IAAI,CAAC,CAAC;IAChC,CAAC;IAED,IAAI;QACF,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjB,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC7B,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC;SAC3B;IACH,CAAC;CACF,CAAA;AAhCY,mBAAmB;IAK3B,mBAAA,aAAM,CAAC,EAAC,WAAW,EAAE,sBAAe,CAAC,SAAS,EAAC,CAAC,CAAA;;GALxC,mBAAmB,CAgC/B;AAhCY,kDAAmB"}

package/dist/types.d.ts

@@ -10,10 +10,18 @@ export interface MetricsOptions {
     defaultMetrics?: {
         disabled?: boolean;
     } & DefaultMetricsCollectorConfiguration;
+    defaultLabels?: {
+        [labelName: string]: string;
+    };
     pushGateway?: {
         disabled?: boolean;
         url: string;
         interval?: number;
+        jobName?: string;
+        groupingKey?: {
+            [key: string]: string;
+        };
+        replaceAll?: boolean;
     };
     openApiSpec?: boolean;
 }

package/dist/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AA+BnD,QAAA,uBAAuB,GAAmB;IACrD,QAAQ,EAAE;QACR,QAAQ,EAAE,UAAU;KACrB;IACD,cAAc,EAAE,EAAE;IAClB,WAAW,EAAE,KAAK;CACnB,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,iCAAiC;AACjC,+CAA+C;AAC/C,gEAAgE;;;AAwCnD,QAAA,uBAAuB,GAAmB;IACrD,QAAQ,EAAE;QACR,QAAQ,EAAE,UAAU;KACrB;IACD,cAAc,EAAE,EAAE;IAClB,WAAW,EAAE,KAAK;CACnB,CAAC"}

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@loopback/metrics",
-  "version": "0.5.2",
+  "version": "0.7.1",
   "description": "An extension exposes metrics for Prometheus with LoopBack 4",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "engines": {
-    "node": "^10.16 || 12 || 14"
+    "node": "^10.16 || 12 || 14 || 15"
   },
   "scripts": {
     "build": "lb-tsc",
@@ -21,21 +21,21 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@loopback/core": "^2.13.1",
-    "@loopback/rest": "^9.1.1"
+    "@loopback/core": "^2.15.1",
+    "@loopback/rest": "^9.2.1"
   },
   "dependencies": {
-    "prom-client": "^12.0.0",
-    "tslib": "^2.0.3"
+    "prom-client": "^13.1.0",
+    "tslib": "^2.1.0"
   },
   "devDependencies": {
-    "@loopback/build": "^6.2.8",
-    "@loopback/core": "^2.13.1",
-    "@loopback/eslint-config": "^10.0.4",
-    "@loopback/rest": "^9.1.1",
-    "@loopback/testlab": "^3.2.10",
-    "@types/express": "^4.17.9",
-    "@types/node": "^10.17.35",
+    "@loopback/build": "^6.3.1",
+    "@loopback/core": "^2.15.1",
+    "@loopback/eslint-config": "^10.1.1",
+    "@loopback/rest": "^9.2.1",
+    "@loopback/testlab": "^3.3.1",
+    "@types/express": "^4.17.11",
+    "@types/node": "^10.17.56",
     "express": "^4.17.1"
   },
   "keywords": [
@@ -56,5 +56,5 @@
     "url": "https://github.com/strongloop/loopback-next.git",
     "directory": "extensions/metrics"
   },
-  "gitHead": "44fc7765fa322c716e8f2914b3831748041ebd8c"
+  "gitHead": "156ca0fcf8fa246ca380ab28b44b3708896be2b6"
 }

package/src/controllers/metrics.controller.ts

@@ -17,7 +17,7 @@ import {DEFAULT_METRICS_OPTIONS, MetricsOptions} from '../types';
 /**
  * OpenAPI definition of metrics response
  */
-const metricsResponse: ResponseObject = {
+const METRICS_RESPONSE: ResponseObject = {
   description: 'Metrics Response',
   content: {
     'text/plain': {
@@ -31,16 +31,16 @@ const metricsResponse: ResponseObject = {
 /**
  * OpenAPI spec for metrics endpoint
  */
-const metricsSpec: OperationObject = {
+const METRICS_SPEC: OperationObject = {
   responses: {
-    '200': metricsResponse,
+    '200': METRICS_RESPONSE,
   },
 };
 
 /**
  * OpenAPI spec to hide endpoints
  */
-const hiddenSpec: OperationObject = {
+const HIDDEN_SPEC: OperationObject = {
   responses: {},
   'x-visibility': 'undocumented',
 };
@@ -49,7 +49,7 @@ export function metricsControllerFactory(
   options: MetricsOptions = DEFAULT_METRICS_OPTIONS,
 ): Constructor<unknown> {
   const basePath = options.endpoint?.basePath ?? '/metrics';
-  const spec = options.openApiSpec ? metricsSpec : hiddenSpec;
+  const spec = options.openApiSpec ? METRICS_SPEC : HIDDEN_SPEC;
 
   /**
    * Controller for metrics endpoint
@@ -57,10 +57,11 @@ export function metricsControllerFactory(
   @injectable({scope: BindingScope.SINGLETON})
   class MetricsController {
     @get(basePath, spec)
-    report(@inject(RestBindings.Http.RESPONSE) res: Response) {
+    async report(@inject(RestBindings.Http.RESPONSE) res: Response) {
       // Set the content type from the register
       res.contentType(register.contentType);
-      res.send(register.metrics());
+      const data = await register.metrics();
+      res.send(data);
       return res;
     }
   }

package/src/interceptors/metrics.interceptor.ts

@@ -9,10 +9,28 @@ import {
   injectable,
   Interceptor,
   InvocationContext,
+  InvocationSource,
   Provider,
   ValueOrPromise,
 } from '@loopback/core';
-import {Counter, Gauge, Histogram, register, Summary} from 'prom-client';
+import {
+  HttpErrors,
+  RequestContext,
+  Response,
+  RouteSource,
+} from '@loopback/rest';
+import {
+  Counter,
+  Gauge,
+  Histogram,
+  LabelValues,
+  register,
+  Summary,
+} from 'prom-client';
+
+type LabelNames = 'targetName' | 'method' | 'path' | 'statusCode';
+
+const labelNames: LabelNames[] = ['targetName', 'method', 'path', 'statusCode'];
 
 /**
  * This interceptor captures metrics for method invocations,
@@ -22,13 +40,13 @@ import {Counter, Gauge, Histogram, register, Summary} from 'prom-client';
  */
 @injectable(asGlobalInterceptor('metrics'), {scope: BindingScope.SINGLETON})
 export class MetricsInterceptor implements Provider<Interceptor> {
-  private static gauge: Gauge<'targetName'>;
+  private static gauge: Gauge<LabelNames>;
 
-  private static histogram: Histogram<'targetName'>;
+  private static histogram: Histogram<LabelNames>;
 
-  private static counter: Counter<'targetName'>;
+  private static counter: Counter<LabelNames>;
 
-  private static summary: Summary<'targetName'>;
+  private static summary: Summary<LabelNames>;
 
   private static setup() {
     // Check if the gauge is registered
@@ -41,25 +59,25 @@ export class MetricsInterceptor implements Provider<Interceptor> {
     this.gauge = new Gauge({
       name: 'loopback_invocation_duration_seconds',
       help: 'method invocation',
-      labelNames: ['targetName'],
+      labelNames,
     });
 
     this.histogram = new Histogram({
       name: 'loopback_invocation_duration_histogram',
       help: 'method invocation histogram',
-      labelNames: ['targetName'],
+      labelNames,
     });
 
     this.counter = new Counter({
       name: 'loopback_invocation_total',
-      help: 'method invocation counts',
-      labelNames: ['targetName'],
+      help: 'method invocation count',
+      labelNames,
     });
 
     this.summary = new Summary({
       name: 'loopback_invocation_duration_summary',
       help: 'method invocation summary',
-      labelNames: ['targetName'],
+      labelNames,
     });
   }
 
@@ -74,22 +92,67 @@ export class MetricsInterceptor implements Provider<Interceptor> {
     next: () => ValueOrPromise<T>,
   ) {
     MetricsInterceptor.setup();
-    const endGauge = MetricsInterceptor.gauge.startTimer({
-      targetName: invocationCtx.targetName,
-    });
-    const endHistogram = MetricsInterceptor.histogram.startTimer({
-      targetName: invocationCtx.targetName,
-    });
-    const endSummary = MetricsInterceptor.summary.startTimer({
+    const {source, parent} = invocationCtx;
+    const labelValues: LabelValues<LabelNames> = {
       targetName: invocationCtx.targetName,
-    });
+    };
+    if (isRouteSource(source)) {
+      labelValues.method = getRequestMethod(source);
+      labelValues.path = getPathPattern(source);
+    }
+    const endGauge = MetricsInterceptor.gauge.startTimer();
+    const endHistogram = MetricsInterceptor.histogram.startTimer();
+    const endSummary = MetricsInterceptor.summary.startTimer();
     try {
-      MetricsInterceptor.counter.inc();
-      return await next();
+      const result = await next();
+      if (isRouteSource(source)) {
+        labelValues.statusCode = getStatusCodeFromResponse(
+          // parent context will be request context if invocation source is route
+          (parent as RequestContext).response,
+          result,
+        );
+      }
+      return result;
+    } catch (err) {
+      if (isRouteSource(source)) {
+        labelValues.statusCode = getStatusCodeFromError(err);
+      }
+      throw err;
     } finally {
-      endGauge();
-      endHistogram();
-      endSummary();
+      MetricsInterceptor.counter.inc(labelValues);
+      endGauge(labelValues);
+      endHistogram(labelValues);
+      endSummary(labelValues);
     }
   }
 }
+
+function getPathPattern(source: RouteSource) {
+  // make sure to use path pattern instead of raw path
+  // this is important since paths can contain unbounded sets of values
+  // such as IDs which would create a new time series for each unique value
+  return source.value.path;
+}
+
+function getRequestMethod(source: RouteSource) {
+  // request methods should be all-uppercase
+  return source.value.verb.toUpperCase();
+}
+
+function getStatusCodeFromResponse(response: Response, result?: unknown) {
+  // interceptors are invoked before result is written to response,
+  // the status code for 200 responses without a result should be 204
+  const noContent = response.statusCode === 200 && result === undefined;
+  return noContent ? 204 : response.statusCode;
+}
+
+function getStatusCodeFromError(err: HttpErrors.HttpError) {
+  // interceptors are invoked before error is written to response,
+  // it is required to retrieve the status code from the error
+  const notFound = err.code === 'ENTITY_NOT_FOUND';
+  return err.statusCode ?? err.status ?? (notFound ? 404 : 500);
+}
+
+function isRouteSource(source?: InvocationSource): source is RouteSource {
+  return source?.type === 'route';
+}

package/src/metrics.component.ts

@@ -13,6 +13,7 @@ import {
   inject,
   injectable,
 } from '@loopback/core';
+import {register} from 'prom-client';
 import {metricsControllerFactory} from './controllers';
 import {MetricsInterceptor} from './interceptors';
 import {MetricsBindings} from './keys';
@@ -44,5 +45,8 @@ export class MetricsComponent implements Component {
     if (options.endpoint && !options.endpoint.disabled) {
       this.application.controller(metricsControllerFactory(options));
     }
+    if (options.defaultLabels) {
+      register.setDefaultLabels(options.defaultLabels);
+    }
   }
 }

package/src/observers/metrics.push.observer.ts

@@ -25,7 +25,15 @@ export class MetricsPushObserver implements LifeCycleObserver {
     if (!gwConfig) return;
     this.gateway = new Pushgateway(gwConfig.url);
     this.interval = setInterval(() => {
-      this.gateway.pushAdd({jobName: 'loopback'}, () => {});
+      const params = {
+        jobName: gwConfig.jobName ?? 'loopback',
+        groupings: gwConfig.groupingKey,
+      };
+      if (gwConfig.replaceAll) {
+        this.gateway.push(params, () => {});
+      } else {
+        this.gateway.pushAdd(params, () => {});
+      }
     }, gwConfig.interval ?? 5000);
   }
 

package/src/types.ts

@@ -18,10 +18,19 @@ export interface MetricsOptions {
     disabled?: boolean;
   } & DefaultMetricsCollectorConfiguration;
 
+  defaultLabels?: {
+    [labelName: string]: string;
+  };
+
   pushGateway?: {
     disabled?: boolean;
     url: string;
     interval?: number;
+    jobName?: string;
+    groupingKey?: {
+      [key: string]: string;
+    };
+    replaceAll?: boolean;
   };
 
   openApiSpec?: boolean;