@axinom/mosaic-db-common 0.34.0-rc.10 → 0.34.0-rc.11

package/dist/monitoring/postgres-metrics.d.ts

@@ -1,5 +1,6 @@
 import { Pool } from 'pg';
 import { Metric } from 'prom-client';
+import { DbLogger } from '../common';
 /**
  * Creates a `Gauge` metric with the name `ax_postgres_<pgPoolType>_connectivity` which can be added to a metric Registry.
  * This metric will have a value of `1` if the Database can be reached via the corresponding Pool (within the given timeout),
@@ -10,5 +11,5 @@ import { Metric } from 'prom-client';
  * @param timeoutInMilliSeconds The maximum time the connectivity check will run during metric collection. Defaults to `1000ms`.
  * @returns A `Gauge` metric with a name `ax_postgres_<pgPoolType>_connectivity`.
  */
-export declare const createPostgresPoolConnectivityMetric: (pgPool: Pool, pgPoolType: 'dbOwnerPool' | 'envOwnerPool' | 'loginPool', timeoutInMilliSeconds?: number) => Metric<string>;
+export declare const createPostgresPoolConnectivityMetric: (logger: DbLogger, pgPool: Pool, pgPoolType: 'dbOwnerPool' | 'envOwnerPool' | 'loginPool', timeoutInMilliSeconds?: number) => Metric<string>;
 //# sourceMappingURL=postgres-metrics.d.ts.map

package/dist/monitoring/postgres-metrics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-metrics.d.ts","sourceRoot":"","sources":["../../src/monitoring/postgres-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAS,MAAM,EAAE,MAAM,aAAa,CAAC;AAO5C;;;;;;;;;GASG;AACH,eAAO,MAAM,oCAAoC,WACvC,IAAI,cACA,aAAa,GAAG,cAAc,GAAG,WAAW,qCAEvD,OAAO,MAAM,CAiBf,CAAC"}
+{"version":3,"file":"postgres-metrics.d.ts","sourceRoot":"","sources":["../../src/monitoring/postgres-metrics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAS,MAAM,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAUrC;;;;;;;;;GASG;AACH,eAAO,MAAM,oCAAoC,WACvC,QAAQ,UACR,IAAI,cACA,aAAa,GAAG,cAAc,GAAG,WAAW,qCAEvD,OAAO,MAAM,CAyBf,CAAC"}

package/dist/monitoring/postgres-metrics.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPostgresPoolConnectivityMetric = void 0;
 const prom_client_1 = require("prom-client");
-const createTimeout = (timeoutInMilliSeconds) => new Promise((_, reject) => setTimeout(() => reject(), timeoutInMilliSeconds));
+const createTimeout = (timeoutInMilliSeconds) => new Promise((_, reject) => setTimeout(() => reject(new Error('METRIC_COLLECTION_TIMEOUT')), timeoutInMilliSeconds));
 /**
  * Creates a `Gauge` metric with the name `ax_postgres_<pgPoolType>_connectivity` which can be added to a metric Registry.
  * This metric will have a value of `1` if the Database can be reached via the corresponding Pool (within the given timeout),
@@ -13,7 +13,7 @@ const createTimeout = (timeoutInMilliSeconds) => new Promise((_, reject) => setT
  * @param timeoutInMilliSeconds The maximum time the connectivity check will run during metric collection. Defaults to `1000ms`.
  * @returns A `Gauge` metric with a name `ax_postgres_<pgPoolType>_connectivity`.
  */
-const createPostgresPoolConnectivityMetric = (pgPool, pgPoolType, timeoutInMilliSeconds = 1000) => {
+const createPostgresPoolConnectivityMetric = (logger, pgPool, pgPoolType, timeoutInMilliSeconds = 1000) => {
     return new prom_client_1.Gauge({
         name: `ax_postgres_${pgPoolType}_connectivity`,
         help: `Connection status from the service to the database via the ${pgPoolType}`,
@@ -25,7 +25,13 @@ const createPostgresPoolConnectivityMetric = (pgPool, pgPoolType, timeoutInMilli
                 ]);
                 this.set(1);
             }
-            catch (_a) {
+            catch (error) {
+                if (error.message === 'METRIC_COLLECTION_TIMEOUT') {
+                    logger.error(`A METRIC_COLLECTION_TIMEOUT error occurred while checking connectivity to the database via the ${pgPoolType} with a timeout of ${timeoutInMilliSeconds}ms.`);
+                }
+                else {
+                    logger.error(error, `METRIC_COLLECTION_ERROR`);
+                }
                 this.set(0);
             }
         },

package/dist/monitoring/postgres-metrics.js.map

@@ -1 +1 @@
-{"version":3,"file":"postgres-metrics.js","sourceRoot":"","sources":["../../src/monitoring/postgres-metrics.ts"],"names":[],"mappings":";;;AACA,6CAA4C;AAE5C,MAAM,aAAa,GAAG,CAAC,qBAA6B,EAAiB,EAAE,CACrE,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAC9B,UAAU,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,qBAAqB,CAAC,CAClD,CAAC;AAEJ;;;;;;;;;GASG;AACI,MAAM,oCAAoC,GAAG,CAClD,MAAY,EACZ,UAAwD,EACxD,qBAAqB,GAAG,IAAI,EACZ,EAAE;IAClB,OAAO,IAAI,mBAAK,CAAC;QACf,IAAI,EAAE,eAAe,UAAU,eAAe;QAC9C,IAAI,EAAE,8DAA8D,UAAU,EAAE;QAEhF,KAAK,CAAC,OAAO;YACX,IAAI;gBACF,MAAM,OAAO,CAAC,IAAI,CAAC;oBACjB,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC;oBAC9D,aAAa,CAAC,qBAAqB,CAAC;iBACrC,CAAC,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACb;YAAC,WAAM;gBACN,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACb;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AArBW,QAAA,oCAAoC,wCAqB/C"}
+{"version":3,"file":"postgres-metrics.js","sourceRoot":"","sources":["../../src/monitoring/postgres-metrics.ts"],"names":[],"mappings":";;;AACA,6CAA4C;AAG5C,MAAM,aAAa,GAAG,CAAC,qBAA6B,EAAiB,EAAE,CACrE,IAAI,OAAO,CAAO,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAC9B,UAAU,CACR,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC,EACpD,qBAAqB,CACtB,CACF,CAAC;AAEJ;;;;;;;;;GASG;AACI,MAAM,oCAAoC,GAAG,CAClD,MAAgB,EAChB,MAAY,EACZ,UAAwD,EACxD,qBAAqB,GAAG,IAAI,EACZ,EAAE;IAClB,OAAO,IAAI,mBAAK,CAAC;QACf,IAAI,EAAE,eAAe,UAAU,eAAe;QAC9C,IAAI,EAAE,8DAA8D,UAAU,EAAE;QAEhF,KAAK,CAAC,OAAO;YACX,IAAI;gBACF,MAAM,OAAO,CAAC,IAAI,CAAC;oBACjB,MAAM,CAAC,KAAK,CAAC,gDAAgD,CAAC;oBAC9D,aAAa,CAAC,qBAAqB,CAAC;iBACrC,CAAC,CAAC;gBACH,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACb;YAAC,OAAO,KAAK,EAAE;gBACd,IAAY,KAAM,CAAC,OAAO,KAAK,2BAA2B,EAAE;oBAC1D,MAAM,CAAC,KAAK,CACV,kGAAkG,UAAU,sBAAsB,qBAAqB,KAAK,CAC7J,CAAC;iBACH;qBAAM;oBACL,MAAM,CAAC,KAAK,CAAQ,KAAK,EAAE,yBAAyB,CAAC,CAAC;iBACvD;gBAED,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aACb;QACH,CAAC;KACF,CAAC,CAAC;AACL,CAAC,CAAC;AA9BW,QAAA,oCAAoC,wCA8B/C"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axinom/mosaic-db-common",
-  "version": "0.34.0-rc.10",
+  "version": "0.34.0-rc.11",
   "description": "This library encapsulates database-related functionality to develop Mosaic based services.",
   "author": "Axinom",
   "license": "PROPRIETARY",
@@ -34,7 +34,7 @@
     "graphile-migrate": "^1.4.0",
     "pg": "^8.11.3",
     "pg-logical-replication": "^2.0.3",
-    "prom-client": "^13.2.0",
+    "prom-client": "^15.1.0",
     "readdirp": "^3.4.0",
     "yargs": "^16.2.0",
     "zapatos": "3.6.0"
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "996702d66aaab62214cb3db5f20966918e6b1007"
+  "gitHead": "c9f280af27b6f60912a1f6a3dbe7952c00203672"
 }

package/src/monitoring/postgres-metrics.ts

@@ -1,9 +1,13 @@
 import { Pool } from 'pg';
 import { Gauge, Metric } from 'prom-client';
+import { DbLogger } from '../common';
 
 const createTimeout = (timeoutInMilliSeconds: number): Promise<void> =>
   new Promise<void>((_, reject) =>
-    setTimeout(() => reject(), timeoutInMilliSeconds),
+    setTimeout(
+      () => reject(new Error('METRIC_COLLECTION_TIMEOUT')),
+      timeoutInMilliSeconds,
+    ),
   );
 
 /**
@@ -17,6 +21,7 @@ const createTimeout = (timeoutInMilliSeconds: number): Promise<void> =>
  * @returns A `Gauge` metric with a name `ax_postgres_<pgPoolType>_connectivity`.
  */
 export const createPostgresPoolConnectivityMetric = (
+  logger: DbLogger,
   pgPool: Pool,
   pgPoolType: 'dbOwnerPool' | 'envOwnerPool' | 'loginPool',
   timeoutInMilliSeconds = 1000,
@@ -32,7 +37,15 @@ export const createPostgresPoolConnectivityMetric = (
           createTimeout(timeoutInMilliSeconds),
         ]);
         this.set(1);
-      } catch {
+      } catch (error) {
+        if ((<Error>error).message === 'METRIC_COLLECTION_TIMEOUT') {
+          logger.error(
+            `A METRIC_COLLECTION_TIMEOUT error occurred while checking connectivity to the database via the ${pgPoolType} with a timeout of ${timeoutInMilliSeconds}ms.`,
+          );
+        } else {
+          logger.error(<Error>error, `METRIC_COLLECTION_ERROR`);
+        }
+
         this.set(0);
       }
     },