Merge pull request #15 from osrs-tracker/feature/prometheus-logging

Added prometheus metrics and fixed + improved logging format

.dockerignore

@@ -1,6 +1,7 @@
 dist
 node_modules
 scripts
+.dockerignore
 .editorconfig
 .gitignore
 .travis.yml

package.json

@@ -1,6 +1,6 @@
 {
   "name": "osrs-tracker-api",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "private": true,
   "author": "Freek Mencke",
   "homepage": "https://twitter.com/FreekMencke",
@@ -24,9 +24,11 @@
     "compression": "1.7.4",
     "cors": "2.8.5",
     "express": "4.16.4",
+    "express-prom-bundle": "^5.1.5",
     "helmet": "3.18.0",
     "mysql": "2.17.1",
-    "node-fetch": "2.6.0"
+    "node-fetch": "2.6.0",
+    "prom-client": "^11.3.0"
   },
   "devDependencies": {
     "@types/body-parser": "^1.17.0",

src/app/app.ts

@@ -3,6 +3,7 @@ import { Worker } from 'cluster';
 import compression from 'compression';
 import cors from 'cors';
 import express, { Application } from 'express';
+import * as prometheusMetricsMiddleware from 'express-prom-bundle';
 import helmet from 'helmet';
 import { config } from '../config/config';
 import { Logger } from './common/logger';
@@ -18,14 +19,20 @@ import { XpRouter } from './routes/xp.router';
 export class App {
   private _app: Application;
 
-  constructor() {
+  static run(worker: Worker): App {
+    const app = new App();
+    app.start(worker);
+    return app;
+  }
+
+  private constructor() {
     this._app = express();
 
     this.setupMiddleware();
     this.setupRouters();
   }
 
-  start(worker: Worker): void {
+  private start(worker: Worker): void {
     this._app.listen(config.port, () => {
       Logger.log(`WORKER ${worker.id} CREATED ON PORT ${config.port}`);
       this.setupRouters();
@@ -38,7 +45,15 @@ export class App {
     this._app.use(cors());
     this._app.use(bodyParser.urlencoded({ extended: true }));
     this._app.use(bodyParser.json());
-    this._app.use(requestLogger(['/health']));
+    this._app.use(requestLogger(['/health', '/metrics']));
+    this._app.use(
+      prometheusMetricsMiddleware({
+        autoregister: false,
+        customLabels: { app: 'osrs-tracker-api' },
+        includeMethod: true,
+        includePath: true,
+      })
+    );
   }
 
   private setupRouters(): void {

src/app/common/file-system-utils.ts → src/app/common/utils/file-system-utils.ts

@@ -1,6 +1,6 @@
 import { exists, mkdir } from 'fs';
 import { join } from 'path';
-import { Logger } from './logger';
+import { Logger } from '../logger';
 
 export class FileSystemUtils {
   static createIconsFolderIfMissing(): void {

src/app/common/sql-utils.ts → src/app/common/utils/sql-utils.ts

@@ -1,6 +1,6 @@
 import { createPool, PoolConnection } from 'mysql';
-import { config } from '../../config/config';
-import { Logger } from './logger';
+import { config } from '../../../config/config';
+import { Logger } from '../logger';
 
 export class SqlUtils {
   private static readonly DB_POOL = createPool({

src/app/middleware/logger.middleware.ts

@@ -6,9 +6,16 @@ export const requestLogger = (blacklist: string[] = []): RequestHandler => (
   res: Response,
   next: NextFunction
 ) => {
+  const start = process.hrtime();
+
   next();
 
   if (blacklist.some(url => req.originalUrl.startsWith(url))) return;
 
-  Logger.log(res.statusCode, req.method, req.originalUrl);
+  res.on('finish', () => {
+    const end = process.hrtime(start);
+    const elapsedTime = `${Math.floor(end[0] * 1000 + end[1] / 1000000)}ms`;
+
+    Logger.log(req.method, req.originalUrl + ';', res.statusCode, res.statusMessage + ';', elapsedTime);
+  });
 };

src/app/repositories/item.repository.ts

@@ -2,16 +2,15 @@ import { PoolConnection } from 'mysql';
 import { Item } from '../data/item';
 
 export class ItemRepository {
-
-  static getItem(itemId: number, connection: PoolConnection): Promise<{ statusCode: number, items?: Item[] }> {
+  static getItem(itemId: number, connection: PoolConnection): Promise<{ statusCode: number; items?: Item[] }> {
     return new Promise(resolve => {
       connection.query('SELECT * FROM Item WHERE id = ?', itemId, (outerError, results: Item[]) => {
         if (outerError) {
           resolve({ statusCode: 500 });
         } else if (results && results.length > 0) {
           resolve({
             statusCode: 200,
-            items: results
+            items: results,
           });
         } else {
           resolve({ statusCode: 404 });
@@ -20,7 +19,7 @@ export class ItemRepository {
     });
   }
 
-  static getItems(query: string, connection: PoolConnection): Promise<{ statusCode: number, items?: Item[] }> {
+  static getItems(query: string, connection: PoolConnection): Promise<{ statusCode: number; items?: Item[] }> {
     return new Promise(resolve => {
       connection.query('SELECT * FROM Item WHERE name LIKE ?', [`%${query}%`], (outerError, results: Item[]) => {
         if (outerError) {
@@ -33,5 +32,4 @@ export class ItemRepository {
       });
     });
   }
-
 }

src/app/routes/health.router-factory.ts

@@ -1,5 +1,5 @@
 import { Application, Router } from 'express';
-import { SqlUtils } from '../common/sql-utils';
+import { SqlUtils } from '../common/utils/sql-utils';
 import { HealthRepository } from '../repositories/health.repository';
 import { RouterFactory } from './router.interface';
 

src/app/routes/item.router-factory.ts

@@ -1,5 +1,5 @@
 import { Application, Router } from 'express';
-import { SqlUtils } from '../common/sql-utils';
+import { SqlUtils } from '../common/utils/sql-utils';
 import { ItemRepository } from '../repositories/item.repository';
 import { RouterFactory } from './router.interface';
 

src/app/routes/news.router-factory.ts

@@ -1,5 +1,5 @@
 import { Application, Router } from 'express';
-import { SqlUtils } from '../common/sql-utils';
+import { SqlUtils } from '../common/utils/sql-utils';
 import { NewsRepository } from '../repositories/news.repository';
 import { RouterFactory } from './router.interface';
 

src/app/routes/player.router-factory.ts

@@ -1,5 +1,5 @@
 import { Application, Router } from 'express';
-import { SqlUtils } from '../common/sql-utils';
+import { SqlUtils } from '../common/utils/sql-utils';
 import { PlayerRepository } from '../repositories/player.repository';
 import { RouterFactory } from './router.interface';
 

src/app/routes/xp.router.ts

@@ -1,5 +1,5 @@
 import { Application, Router } from 'express';
-import { SqlUtils } from '../common/sql-utils';
+import { SqlUtils } from '../common/utils/sql-utils';
 import { XpRepository } from '../repositories/xp.repository';
 import { RouterFactory } from './router.interface';
 

src/config/config.dev.ts

@@ -6,6 +6,7 @@ const dbCredentials: PoolConfig = JSON.parse(readFileSync('src/config/secrets/db
 
 export const config: IConfig = {
   port: Number(process.env.PORT) || 8080,
+  portMetrics: Number(process.env.PORT_METRICS) || 8088,
   poolConfig: Object.assign(dbCredentials, {
     ssl: {
       ca: readFileSync('src/config/secrets/db-ca.pem'),

src/config/config.interface.ts

@@ -2,5 +2,6 @@ import { PoolConfig } from 'mysql';
 
 export interface IConfig {
   port: number;
+  portMetrics: number;
   poolConfig: PoolConfig;
 }

src/config/config.ts

@@ -6,6 +6,7 @@ const dbCredentials: PoolConfig = JSON.parse(readFileSync('/run/secrets/db-osrs-
 
 export const config: IConfig = {
   port: Number(process.env.PORT) || 8080,
+  portMetrics: Number(process.env.PORT_METRICS) || 8088,
   poolConfig: Object.assign(dbCredentials, {
     ssl: {
       ca: readFileSync('/run/secrets/db-ca.pem'),

src/main.ts

@@ -1,19 +1,26 @@
 import cluster from 'cluster';
+import * as express from 'express';
+import { clusterMetrics } from 'express-prom-bundle';
 import os from 'os';
 import { App } from './app/app';
-import { FileSystemUtils } from './app/common/file-system-utils';
 import { Logger } from './app/common/logger';
+import { FileSystemUtils } from './app/common/utils/file-system-utils';
+import { config } from './config/config';
 
 if (cluster.isMaster) {
   FileSystemUtils.createIconsFolderIfMissing();
   Logger.log('OSRS TRACKER API ACTIVE - FORKING WORKERS');
 
   os.cpus().forEach(() => cluster.fork());
 
+  const metricsApp = express();
+  metricsApp.use('/metrics', clusterMetrics());
+  metricsApp.listen(config.portMetrics);
+
   cluster.on('exit', worker => {
     Logger.log(`WORKER ${worker.id} DIED - CREATING NEW WORKER`);
     cluster.fork();
   });
 } else {
-  new App().start(cluster.worker);
+  App.run(cluster.worker);
 }