@tryghost/prometheus-metrics 3.0.2 → 3.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2026 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,26 +2,22 @@
 
 A standalone server for exporting prometheus metrics from Ghost
 
-
 ## Purpose
 
 Prometheus metrics integration for exposing Ghost runtime counters, gauges, and histograms.
 
 ## Usage
 
-
 ## Develop
 
 This is a monorepo package.
 
 Follow the instructions for the top-level repo.
-1. `git clone` this repo & `cd` into it as usual
-2. Run `yarn` to install top-level dependencies.
-
 
+1. `git clone` this repo & `cd` into it as usual
+2. Run `pnpm install` to install top-level dependencies.
 
 ## Test
 
-- `yarn lint` run just eslint
-- `yarn test` run lint and tests
-
+- `pnpm lint` runs oxlint
+- `pnpm test` runs lint and tests

package/build/MetricsServer.d.ts

@@ -14,7 +14,7 @@ export declare class MetricsServer {
     private isShuttingDown;
     private createApp;
     private createStoppableServer;
-    constructor({ serverConfig, handler, createApp, createStoppableServer }: {
+    constructor({ serverConfig, handler, createApp, createStoppableServer, }: {
         serverConfig: ServerConfig;
         handler: express.Handler;
         createApp?: CreateApp;

package/build/MetricsServer.js

@@ -16,7 +16,7 @@ class MetricsServer {
     isShuttingDown;
     createApp;
     createStoppableServer;
-    constructor({ serverConfig, handler, createApp, createStoppableServer }) {
+    constructor({ serverConfig, handler, createApp, createStoppableServer, }) {
         this.serverConfig = serverConfig;
         this.handler = handler;
         this.app = null;

package/build/PrometheusClient.d.ts

@@ -91,7 +91,7 @@ export declare class PrometheusClient {
      * @param labelNames - The names of the labels for the metric
      * @returns The counter metric
      */
-    registerCounter({ name, help, labelNames }: {
+    registerCounter({ name, help, labelNames, }: {
         name: string;
         help: string;
         labelNames?: string[];
@@ -103,7 +103,7 @@ export declare class PrometheusClient {
      * @param collect - The collect function to use for the gauge
      * @returns The gauge metric
      */
-    registerGauge({ name, help, collect }: {
+    registerGauge({ name, help, collect, }: {
         name: string;
         help: string;
         collect?: () => void;
@@ -116,7 +116,7 @@ export declare class PrometheusClient {
      * @param collect - The collect function to use for the summary
      * @returns The summary metric
      */
-    registerSummary({ name, help, percentiles, maxAgeSeconds, ageBuckets, pruneAgedBuckets, collect }: {
+    registerSummary({ name, help, percentiles, maxAgeSeconds, ageBuckets, pruneAgedBuckets, collect, }: {
         name: string;
         help: string;
         percentiles?: number[];
@@ -133,7 +133,7 @@ export declare class PrometheusClient {
      * @param collect - The collect function to use for the histogram
      * @returns The histogram metric
      */
-    registerHistogram({ name, help, buckets }: {
+    registerHistogram({ name, help, buckets, }: {
         name: string;
         help: string;
         buckets: number[];

package/build/PrometheusClient.js

@@ -43,8 +43,8 @@ class PrometheusClient {
                 timeout: 5000,
                 agent: new http_1.default.Agent({
                     keepAlive: true,
-                    maxSockets: 1
-                })
+                    maxSockets: 1,
+                }),
             });
             this.pushMetrics();
             this.pushInterval = setInterval(() => {
@@ -71,7 +71,7 @@ class PrometheusClient {
             catch (err) {
                 let error;
                 if (typeof err === 'object' && err !== null && 'code' in err) {
-                    error = 'Error pushing metrics to pushgateway: ' + err.code;
+                    error = ('Error pushing metrics to pushgateway: ' + err.code);
                 }
                 else {
                     error = 'Error pushing metrics to pushgateway: Unknown error';
@@ -179,11 +179,11 @@ class PrometheusClient {
      * @param labelNames - The names of the labels for the metric
      * @returns The counter metric
      */
-    registerCounter({ name, help, labelNames = [] }) {
+    registerCounter({ name, help, labelNames = [], }) {
         return new this.client.Counter({
             name: `${this.prefix}${name}`,
             help,
-            labelNames
+            labelNames,
         });
     }
     /**
@@ -193,11 +193,11 @@ class PrometheusClient {
      * @param collect - The collect function to use for the gauge
      * @returns The gauge metric
      */
-    registerGauge({ name, help, collect }) {
+    registerGauge({ name, help, collect, }) {
         return new this.client.Gauge({
             name: `${this.prefix}${name}`,
             help,
-            collect
+            collect,
         });
     }
     /**
@@ -208,7 +208,7 @@ class PrometheusClient {
      * @param collect - The collect function to use for the summary
      * @returns The summary metric
      */
-    registerSummary({ name, help, percentiles, maxAgeSeconds, ageBuckets, pruneAgedBuckets, collect }) {
+    registerSummary({ name, help, percentiles, maxAgeSeconds, ageBuckets, pruneAgedBuckets, collect, }) {
         return new this.client.Summary({
             name: `${this.prefix}${name}`,
             help,
@@ -216,7 +216,7 @@ class PrometheusClient {
             maxAgeSeconds,
             ageBuckets,
             pruneAgedBuckets,
-            collect
+            collect,
         });
     }
     /**
@@ -227,11 +227,11 @@ class PrometheusClient {
      * @param collect - The collect function to use for the histogram
      * @returns The histogram metric
      */
-    registerHistogram({ name, help, buckets }) {
+    registerHistogram({ name, help, buckets, }) {
         return new this.client.Histogram({
             name: `${this.prefix}${name}`,
             help,
-            buckets: buckets
+            buckets: buckets,
         });
     }
     // Utility functions for creating custom metrics
@@ -246,49 +246,49 @@ class PrometheusClient {
             help: 'The maximum number of connections allowed in the pool',
             collect() {
                 this.set(knexInstance.client.pool.max);
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_min`,
             help: 'The minimum number of connections allowed in the pool',
             collect() {
                 this.set(knexInstance.client.pool.min);
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_active`,
             help: 'The number of active connections to the database, which can be in use or idle',
             collect() {
                 this.set(knexInstance.client.pool.numUsed() + knexInstance.client.pool.numFree());
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_used`,
             help: 'The number of connections currently in use by the database',
             collect() {
                 this.set(knexInstance.client.pool.numUsed());
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_idle`,
             help: 'The number of active connections currently idle in pool',
             collect() {
                 this.set(knexInstance.client.pool.numFree());
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_pending_acquires`,
             help: 'The number of connections currently waiting to be acquired from the pool',
             collect() {
                 this.set(knexInstance.client.pool.numPendingAcquires());
-            }
+            },
         });
         this.registerGauge({
             name: `db_connection_pool_pending_creates`,
             help: 'The number of connections currently waiting to be created',
             collect() {
                 this.set(knexInstance.client.pool.numPendingCreates());
-            }
+            },
         });
         const queryDurationSummary = this.registerSummary({
             name: `db_query_duration_seconds`,
@@ -296,7 +296,7 @@ class PrometheusClient {
             percentiles: [0.5, 0.9, 0.99],
             maxAgeSeconds: 60,
             ageBuckets: 6,
-            pruneAgedBuckets: false
+            pruneAgedBuckets: false,
         });
         const acquireDurationSummary = this.registerSummary({
             name: `db_connection_acquire_duration_seconds`,
@@ -304,7 +304,7 @@ class PrometheusClient {
             percentiles: [0.5, 0.9, 0.99],
             maxAgeSeconds: 60,
             ageBuckets: 6,
-            pruneAgedBuckets: false
+            pruneAgedBuckets: false,
         });
         const createDurationSummary = this.registerSummary({
             name: `db_connection_create_duration_seconds`,
@@ -312,7 +312,7 @@ class PrometheusClient {
             percentiles: [0.5, 0.9, 0.99],
             maxAgeSeconds: 60,
             ageBuckets: 6,
-            pruneAgedBuckets: false
+            pruneAgedBuckets: false,
         });
         knexInstance.on('query', (query) => {
             // Add the query to the map

package/package.json

@@ -1,48 +1,47 @@
 {
   "name": "@tryghost/prometheus-metrics",
-  "version": "3.0.2",
+  "version": "3.1.0",
+  "author": "Ghost Foundation",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/framework.git",
     "directory": "packages/prometheus-metrics"
   },
-  "author": "Ghost Foundation",
+  "files": [
+    "build"
+  ],
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
   "publishConfig": {
     "access": "public"
   },
-  "main": "build/index.js",
-  "types": "build/index.d.ts",
-  "scripts": {
-    "dev": "tsc --watch --preserveWatchOutput --sourceMap",
-    "build": "yarn build:ts",
-    "build:ts": "tsc",
-    "prepare": "tsc",
-    "test:unit": "NODE_ENV=testing vitest run --coverage",
-    "test": "yarn test:types && yarn test:unit",
-    "test:types": "tsc --noEmit",
-    "lint:code": "eslint src/ --ext .ts --cache",
-    "lint": "yarn lint:code && yarn lint:test",
-    "lint:test": "eslint -c test/.eslintrc.js test/ --ext .ts --cache"
+  "dependencies": {
+    "express": "5.2.1",
+    "prom-client": "15.1.3",
+    "stoppable": "1.1.0",
+    "@tryghost/debug": "2.1.0",
+    "@tryghost/logging": "4.1.0"
   },
-  "files": [
-    "build"
-  ],
   "devDependencies": {
     "@types/express": "5.0.6",
-    "@types/sinon": "21.0.0",
+    "@types/node": "24.12.2",
+    "@types/sinon": "21.0.1",
     "@types/stoppable": "1.1.3",
     "@types/supertest": "7.2.0",
-    "knex": "3.1.0",
-    "nock": "14.0.11",
-    "sinon": "21.0.2",
+    "knex": "3.2.9",
+    "nock": "14.0.12",
+    "sinon": "21.1.2",
     "supertest": "7.2.2",
     "ts-node": "10.9.2",
     "typescript": "5.9.3"
   },
-  "dependencies": {
-    "@tryghost/logging": "^4.0.2",
-    "express": "5.2.1",
-    "prom-client": "15.1.3",
-    "stoppable": "1.1.0"
+  "scripts": {
+    "dev": "tsc --watch --preserveWatchOutput --sourceMap",
+    "build": "pnpm run build:ts",
+    "build:ts": "tsc",
+    "test:unit": "NODE_ENV=testing vitest run --coverage",
+    "test": "pnpm run test:types && pnpm run test:unit",
+    "test:types": "tsc --noEmit",
+    "lint": "oxlint -c ../../.oxlintrc.json ."
   }
-}
+}