[DEVX-364] Add Request Time and Custom Metrics

.circleci/config.yml

@@ -75,7 +75,7 @@ jobs:
       - restore_cache: *restore_yarn_cache_node_16
       - run:
           name: Installing dependencies
-          command: yarn install --frozen-lockfile
+          command: yarn install --ignore-engines --frozen-lockfile # temp ignore engine checks [will deprecate node v16 soon]
       - save_cache: *save_yarn_cache_node_16
       - run:
           name: Install example dependencies

packages/sdk-client/package.json

@@ -34,7 +34,8 @@
   },
   "dependencies": {
     "buffer": "^6.0.3",
-    "node-fetch": "^2.6.1"
+    "node-fetch": "^2.6.1",
+    "@commercetools/ts-sdk-apm": "latest"
   },
   "files": ["dist", "CHANGELOG.md"],
   "author": "Chukwuemeka Ajima <meeky.ae@gmail.com>",

packages/sdk-client/src/sdk-client/client.ts

@@ -10,8 +10,9 @@ import {
   ProcessOptions,
   SuccessResult,
 } from '../types/sdk.d'
-import { parseURLString, stringifyURLString } from '../utils'
+import { parseURLString, stringifyURLString, time } from '../utils'
 import validate from './validate'
+import { newrelic, datadog } from '@commercetools/ts-sdk-apm'
 
 let _options: ClientOptions
 export const PAGE_LIMIT = 20
@@ -190,6 +191,20 @@ export default function createClient(options: ClientOptions): Client {
             error: undefined,
           }
         )
+
+        // collect metrics
+        const end = time()
+        const start = request.startTime
+
+        // record for newrelic
+        newrelic.recordMetric(`Commercetools/Client/Request/Total`, start - end)
+
+        // record for datadog
+        datadog
+          .init()
+          .dogstatsd.gauge(`Commercetools_Client_Request_Total`, start - end, {
+            env: 'dev',
+          })
       })
     },
   }

packages/sdk-client/src/types/sdk.d.ts

@@ -93,6 +93,7 @@ export type Dispatch = (
 
 export type Middleware = (next: Dispatch) => Dispatch
 export interface ClientRequest {
+  startTime: number
   baseUri?: string
   uri?: string
   headers?: VariableMap

packages/sdk-client/src/utils/index.ts

@@ -1 +1,2 @@
 export { parseURLString, stringifyURLString } from './url';
+export { default as time } from './time';

packages/sdk-client/src/utils/time.ts

@@ -0,0 +1,7 @@
+// export default typeof BigInt !== 'undefined'
+//   ? typeof process !== 'undefined' &&
+//     typeof process.hrtime !== 'undefined' &&
+//     typeof process.hrtime.bigint === 'function' ? () => process.hrtime.bigint()
+//     : () => BigInt(Date.now() * 1e6) : () => Date.now() * 1e6;
+
+export default () => Date.now() * 1e6

packages/ts-sdk-apm/package.json

@@ -12,6 +12,8 @@
     "@opentelemetry/auto-instrumentations-node": "^0.47.0",
     "@opentelemetry/exporter-metrics-otlp-http": "^0.52.0",
     "@opentelemetry/sdk-node": "^0.52.0",
+    "dd-trace": "^5.17.0",
+    "newrelic": "^11.22.0",
     "uuid": "10.0.0"
   },
   "publishConfig": {

packages/ts-sdk-apm/src/agents.ts

@@ -0,0 +1,9 @@
+// module.exports = require('dd-trace')
+// module.exports = require('newrelic')
+
+import datadog from 'dd-trace'
+import newrelic from 'newrelic'
+
+datadog.dogstatsd.increment
+
+export { datadog, newrelic }

packages/ts-sdk-apm/src/apm.ts

@@ -21,6 +21,15 @@ const defaultOptions = {
   tracer: () => require('../opentelemetry'),
 }
 
+const startTime =
+  typeof BigInt !== 'undefined'
+    ? typeof process !== 'undefined' &&
+      typeof process.hrtime !== 'undefined' &&
+      typeof process.hrtime.bigint === 'function'
+      ? () => process.hrtime.bigint()
+      : () => BigInt(Date.now() * 1e6)
+    : () => Date.now() * 1e6
+
 export default function createTelemetryMiddleware(
   options: OTelemetryMiddlewareOptions
 ): Middleware {
@@ -45,6 +54,7 @@ export default function createTelemetryMiddleware(
       const nextRequest = {
         ...request,
         ...options,
+        startTime,
       }
 
       next(nextRequest, response)

packages/ts-sdk-apm/src/index.ts

@@ -1,2 +1,3 @@
 export * from '../types/types.d'
 export { default as createTelemetryMiddleware } from './apm'
+export * from './agents';

packages/ts-sdk-apm/test/apm.test/apm.test.ts

@@ -32,8 +32,8 @@ describe('apm', () => {
   describe('apm test - null tracer configurations', () => {
     const response = createTestResponse({})
     const telemetryMiddleware = createTelemetryMiddleware({
-      apm: null,
-      tracer: null,
+      apm: null as any,
+      tracer: null as any,
     })
 
     const next = (req: MiddlewareRequest) => {