@commercetools/ts-sdk-apm 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @commercetools/ts-sdk-apm
 
+## 3.3.0
+
+### Minor Changes
+
+- [#936](https://github.com/commercetools/commercetools-sdk-typescript/pull/936) [`f702837`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f702837c3ec7fde11641c94abb5ed4dab138acf9) Thanks [@barbara79](https://github.com/barbara79)! - updated documentation with client v3
+
 ## 3.2.0
 
 ### Minor Changes

package/README.md

@@ -26,7 +26,7 @@ Import the package and add it to the SDK client using `withTelemetryMiddleware()
 
 ```typescript
 // import the @commercetools/ts-sdk-apm package
-import { ClientBuilder } from '@commercetools/sdk-client-v2'
+import { ClientBuilder } from '@commercetools/ts-client'
 import { createTelemetryMiddleware } from '@commercetools/ts-sdk-apm'
 
 // newrelic options
@@ -47,13 +47,19 @@ const client = new ClientBuilder()
 
 ## Using a custom (user-defined options)
 
-All the monitoring and tracing functionality has been implemented by default however, the `telemetryOptions` accepts three function parameters `createTelemetryMiddleware`, `apm` and `tracer`, the `createTelemetryMiddleware` and `tracer` can be custom implemented.
+All monitoring and tracing functionality are implemented by default.
+The `telemetryOptions` accepts four configuration options: `createTelemetryMiddleware`, `apm`, `tracer` and `customMetrics`. The `createTelemetryMiddleware` and `tracer` parameters can be custom-implemented.
+Additionally, `customMetrics` can be included to record custom metrics based on available APM. For example, if we want to record and send custom metrics to Newrelic, we can set the `newrelic` field to `true` in the customMetrics configuration option same goes for datadog. For collecting custom metrics only Newrelic and Datadog are currently supported.
 
 ```typescript
 type telemetryOptions = {
-  createTelemetryMiddleware: (options: Omit<telemetryOptions, 'createTelemetryMiddleware'>) => Middleware;
-  apm?: () => typeof require('newrelic');
-  tracer?: () => typeof require('/absolute-path-to-a-tracer(opentelemetry)-module')
+  createTelemetryMiddleware: (options: Omit<telemetryOptions, 'createTelemetryMiddleware'>) => Middleware,
+  apm?: () => typeof require('newrelic'),
+  tracer?: () => typeof require('/absolute-path-to-a-tracer(opentelemetry)-module'),
+  customMetrics?: {
+      newrelic?: true;
+      datadog?: false; // it can be omitted
+    }
 }
 ```
 
@@ -66,6 +72,9 @@ const telemetryOptions = {
     require(
       require('path').join(__dirname, '..', '..', 'custom-telemetry-module.js')
     ), // make sure the require takes in an absolute path to the custom tracer module.
+  customMetrics: {
+    datadog: true,
+  },
 }
 ```
 

package/dist/declarations/types/types.d.ts

@@ -3,7 +3,6 @@ export type MiddlewareRequest = ClientRequest
 
 export type Middleware = (next: Next) => (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 
-// export type Dispatch = (next: Next) => (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 export type Next = (request: MiddlewareRequest) => Promise<MiddlewareResponse>
 
 export type MiddlewareResponse<T = unknown> = {
@@ -33,7 +32,7 @@ export interface ClientRequest {
 
 export type ClientResponse<T = any> = {
   body: T
-  code?: number
+  code?: string
   statusCode?: number
   headers?: Record<string, any>
   error?: HttpErrorType
@@ -43,7 +42,7 @@ export type ClientResponse<T = any> = {
 export type HttpErrorType = {
   name?: string
   message: string
-  code?: number
+  code?: string
   status?: number
   method: MethodType
   statusCode: number

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/ts-sdk-apm",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "commercetools typescript SDK application performance monitoring.",
   "main": "dist/commercetools-ts-sdk-apm.cjs.js",
   "module": "dist/commercetools-ts-sdk-apm.esm.js",
@@ -14,7 +14,7 @@
     "@opentelemetry/sdk-node": "^0.57.0",
     "dd-trace": "^5.31.0",
     "newrelic": "^12.10.0",
-    "uuid": "11.0.5"
+    "uuid": "11.1.0"
   },
   "publishConfig": {
     "access": "public"
@@ -55,6 +55,6 @@
     "post_process_generate": "yarn organize_imports"
   },
   "devDependencies": {
-    "@types/newrelic": "9.14.7"
+    "@types/newrelic": "9.14.8"
   }
 }