metrics (#29)

* add barebones metrics and bump `dwn-sdk-js` to `0.0.32` * update `CODEOWNERS` * Fix tests failing due to upstream dwn-sdk-js error code change Signed-off-by: Frank Hinek <[email protected]> * Consist catch block Signed-off-by: Frank Hinek <[email protected]> --------- Signed-off-by: Frank Hinek <[email protected]> Co-authored-by: Frank Hinek <[email protected]>
decentralized-identity · May 16, 2023 · 5178a0c · 5178a0c
1 parent 977278c
commit 5178a0c
Show file tree

Hide file tree

Showing 7 changed files with 559 additions and 514 deletions.
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -11,6 +11,7 @@
 # These owners will be the default owners for everything in the repo.
 *       @michaelneale
 *       @mistermoe
+*       @frankhinek
 
 
 # -----------------------------------------------

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -3,13 +3,15 @@
     "type": "module",
     "version": "0.0.2",
     "dependencies": {
-        "@tbd54566975/dwn-sdk-js": "0.0.30",
+        "@tbd54566975/dwn-sdk-js": "0.0.32",
         "bytes": "3.1.2",
         "node-fetch": "3.3.1",
         "cors": "2.8.5",
         "express": "4.18.2",
         "multiformats": "11.0.2",
+        "prom-client": "14.2.0",
         "readable-stream": "4.3.0",
+        "response-time": "2.3.2",
         "uuid": "9.0.0",
         "ws": "8.12.0"
     },
@@ -38,4 +40,4 @@
         "test": "npm run compile && cp -R tests/fixtures dist/tests && mocha dist/tests/*.spec.js",
         "server": "npm run compile && node dist/src/main.js"
     }
-}
+}
diff --git a/src/http-api.ts b/src/http-api.ts
@@ -1,9 +1,11 @@
-import type { Express, Request } from 'express';
+import type { Express, Request, Response } from 'express';
 import type { Dwn } from '@tbd54566975/dwn-sdk-js';
 import type { RequestContext } from './lib/json-rpc-router.js';
+import responseTime from 'response-time';
 
 import cors from 'cors';
 import express from 'express';
+import { register, Histogram } from 'prom-client';
 
 import { v4 as uuidv4 } from 'uuid';
 
@@ -18,13 +20,38 @@ export class HttpApi {
     this.api = express();
     this.dwn = dwn;
 
+    const responseHistogram = new Histogram({
+      name       : 'http_response',
+      help       : 'response histogram',
+      buckets    : [50, 250, 500, 750, 1000],
+      labelNames : ['route', 'code'],
+    });
+
     this.api.use(cors({ exposedHeaders: 'dwn-response' }));
+    this.api.use(responseTime((req: Request, res: Response, time) => {
+      const url = req.url === '/' ? '/jsonrpc' : req.url;
+      const route = (req.method + url).toLowerCase()
+        .replace(/[:.]/g, '')
+        .replace(/\//g, '_');
+
+      const statusCode = res.statusCode.toString();
+      responseHistogram.labels(route, statusCode).observe(time);
+    }));
 
     this.api.get('/health', (_req, res) => {
       // return 200 ok
       return res.json({ ok: true });
     });
 
+    this.api.get('/metrics', async (req, res) => {
+      try {
+        res.set('Content-Type', register.contentType);
+        res.end(await register.metrics());
+      } catch (e) {
+        res.status(500).end(e);
+      }
+    });
+
     this.api.get('/', (_req, res) => {
       // return a plain text string
       res.setHeader('content-type', 'text/plain');
@@ -43,7 +70,7 @@ export class HttpApi {
 
       try {
         dwnRequest = JSON.parse(dwnRequest);
-      } catch(e) {
+      } catch (e) {
         const reply = createJsonRpcErrorResponse(uuidv4(), JsonRpcErrorCodes.BadRequest, e.message);
 
         return res.status(400).json(reply);

diff --git a/src/json-rpc-handlers/dwn/process-message.ts b/src/json-rpc-handlers/dwn/process-message.ts
@@ -29,7 +29,7 @@ export const handleDwnProcessMessage: JsonRpcHandler = async (dwnRequest, contex
     }
 
     return responsePayload;
-  } catch(e) {
+  } catch (e) {
     const jsonRpcResponse = createJsonRpcErrorResponse(
       requestId, JsonRpcErrorCodes.InternalError, e.message);
 

diff --git a/src/ws-api.ts b/src/ws-api.ts
@@ -65,7 +65,7 @@ export class WsApi {
           }
 
           dwnRequest = JSON.parse(dwnRequest);
-        } catch(e) {
+        } catch (e) {
           const jsonRpcResponse = createJsonRpcErrorResponse(
             uuidv4(), JsonRpcErrorCodes.BadRequest, e.message);
 

diff --git a/tests/http-api.spec.ts b/tests/http-api.spec.ts
@@ -81,7 +81,7 @@ describe('http api', function() {
 
     const { reply } = body.result;
     expect(reply.status.code).to.equal(400);
-    expect(reply.status.detail).to.include('MessageStoreDataNotFound');
+    expect(reply.status.detail).to.include('RecordsWriteMissingDataStream');
   });
 
   it('exposes dwn-response header', async function() {