@tryghost/prometheus-metrics 1.0.5 → 1.0.6

package/README.md

@@ -3,6 +3,10 @@
 A standalone server for exporting prometheus metrics from Ghost
 
 
+## Purpose
+
+Prometheus metrics integration for exposing Ghost runtime counters, gauges, and histograms.
+
 ## Usage
 
 

package/build/MetricsServer.d.ts

@@ -4,15 +4,21 @@ type ServerConfig = {
     host: string;
     port: number;
 };
+type CreateApp = () => express.Application;
+type CreateStoppableServer = (server: ReturnType<express.Application['listen']>, grace?: number) => stoppable.StoppableServer;
 export declare class MetricsServer {
     private serverConfig;
     private handler;
     private app;
     private httpServer;
     private isShuttingDown;
-    constructor({ serverConfig, handler }: {
+    private createApp;
+    private createStoppableServer;
+    constructor({ serverConfig, handler, createApp, createStoppableServer }: {
         serverConfig: ServerConfig;
         handler: express.Handler;
+        createApp?: CreateApp;
+        createStoppableServer?: CreateStoppableServer;
     });
     start(): Promise<{
         app: express.Application;

package/build/MetricsServer.js

@@ -14,29 +14,30 @@ class MetricsServer {
     app;
     httpServer;
     isShuttingDown;
-    constructor({ serverConfig, handler }) {
-        // initialize local variables
+    createApp;
+    createStoppableServer;
+    constructor({ serverConfig, handler, createApp, createStoppableServer }) {
         this.serverConfig = serverConfig;
         this.handler = handler;
         this.app = null;
         this.httpServer = null;
         this.isShuttingDown = false;
+        this.createApp = createApp ?? express_1.default;
+        this.createStoppableServer = createStoppableServer ?? stoppable_1.default;
     }
     async start() {
-        // start the server
         debug('Starting metrics server');
-        this.app = (0, express_1.default)();
+        this.app = this.createApp();
         this.app.get('/metrics', this.handler);
         const httpServer = this.app.listen(this.serverConfig.port, this.serverConfig.host, () => {
             debug(`Metrics server listening at ${this.serverConfig.host}:${this.serverConfig.port}`);
         });
-        this.httpServer = (0, stoppable_1.default)(httpServer, 0);
+        this.httpServer = this.createStoppableServer(httpServer, 0);
         process.on('SIGINT', () => this.shutdown());
         process.on('SIGTERM', () => this.shutdown());
         return { app: this.app, httpServer: this.httpServer };
     }
     async stop() {
-        // stop the server
         debug('Stopping metrics server');
         if (this.httpServer && this.httpServer.listening) {
             await this.httpServer.stop();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/prometheus-metrics",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/TryGhost/framework.git",
@@ -17,7 +17,7 @@
     "build": "yarn build:ts",
     "build:ts": "tsc",
     "prepare": "tsc",
-    "test:unit": "NODE_ENV=testing c8 --src src --all --check-coverage --90 --reporter text --reporter cobertura mocha -r ts-node/register './test/**/*.test.ts'",
+    "test:unit": "NODE_ENV=testing c8 --src src --all --check-coverage --100 --reporter text --reporter cobertura mocha -r ts-node/register './test/**/*.test.ts'",
     "test": "yarn test:types && yarn test:unit",
     "test:types": "tsc --noEmit",
     "lint:code": "eslint src/ --ext .ts --cache",