Add basic query performance monitoring to the TableRepository

Author: AJCStriker

package.json

@@ -1,6 +1,6 @@
 {
   "name": "strontium",
-  "version": "2.7.9",
+  "version": "2.7.10",
   "description": "Strontium is a TypeScript toolkit for High Performance API servers built for Production not Projects.",
   "main": "lib/src/index.js",
   "types": "lib/src/index.d.ts",

src/query/drivers/sql/TableRepository.ts

@@ -8,6 +8,7 @@ import {
 } from "../../../datastore"
 import { injectable } from "inversify"
 import { isUndefined, omitBy } from "lodash"
+import { Logger } from "../../../logging"
 
 import { Filter, compileSQLFilter } from "../.."
 
@@ -31,7 +32,8 @@ export abstract class TableRepository<
         protected store: SQLStore,
         protected tableName: string,
         protected queryFields: Array<keyof T>,
-        protected primaryKeyField: K
+        protected primaryKeyField: K,
+        protected logger?: Logger
     ) {
         super()
 
@@ -114,6 +116,7 @@ export abstract class TableRepository<
         } = {},
         connection: SQLStore = this.store
     ): Promise<Array<T>> {
+        let startTime = process.hrtime()
         let [filterQuery, filterParameters] = compileSQLFilter(filter)
         let parameters = [this.tableName, ...filterParameters]
 
@@ -150,6 +153,8 @@ export abstract class TableRepository<
             processedQuery,
             processedParameters
         )
+
+        this.recordQueryTime(processedQuery, startTime)
         return results
     }
 
@@ -208,4 +213,25 @@ export abstract class TableRepository<
     async generateID(): Promise<any> {
         return undefined
     }
+
+    protected recordQueryTime(
+        queryString: string,
+        startTime: [number, number]
+    ): void {
+        if (this.logger !== undefined) {
+            let runtime = process.hrtime(startTime)
+
+            this.logger.debug(
+                `[REPOSITORY - QUERY - DIAGNOSTICS] ${
+                    this.tableName
+                } query complete - ${runtime[0]} s and ${runtime[1] /
+                    1000000} ms`,
+                {
+                    query: queryString,
+                    seconds: runtime[0],
+                    milliseconds: runtime[1] / 1000000,
+                }
+            )
+        }
+    }
 }