@commercetools/ts-sdk-apm 1.0.2 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @commercetools/ts-sdk-apm
 
+## 3.0.0
+
+### Major Changes
+
+- [#896](https://github.com/commercetools/commercetools-sdk-typescript/pull/896) [`f9b8cb6`](https://github.com/commercetools/commercetools-sdk-typescript/commit/f9b8cb605d99fe5ece13bdc3c152eb4818e19b3b) Thanks [@lojzatran](https://github.com/lojzatran)! - Remove support of nodejs 16
+
+## 2.0.0
+
+### Major Changes
+
+- [#564](https://github.com/commercetools/commercetools-sdk-typescript/pull/564) [`db69db1`](https://github.com/commercetools/commercetools-sdk-typescript/commit/db69db1f2a1f6ca69858c272f3905b96b6180bd2) Thanks [@ajimae](https://github.com/ajimae)! - - remove newrelic as dependency in `@commercetools/ts-sdk-apm` package
+  - add useragent key with a default `typescript-sdk-apm-middleware` string
+  - add example express app on how to add `dynatrace` monitoring in the ts sdk
+
 ## 1.0.2
 
 ### Patch Changes

package/README.md

@@ -63,12 +63,9 @@ Example
 const telemetryOptions = {
   createTelemetryMiddleware, // coming from the `@commercetools/ts-sdk-apm or a custom implementation
   tracer: () =>
-    require(require('path').join(
-      __dirname,
-      '..',
-      '..',
-      'custom-telemetry-module.js'
-    )), // make sure the require takes in an absolute path to the custom tracer module.
+    require(
+      require('path').join(__dirname, '..', '..', 'custom-telemetry-module.js')
+    ), // make sure the require takes in an absolute path to the custom tracer module.
 }
 ```
 

package/dist/commercetools-ts-sdk-apm.browser.cjs.js

@@ -7,17 +7,23 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * opentelemetry tracer modules
  */
 const defaultOptions = {
-  apm: () => require('newrelic'),
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   * Note: don't forget to install newrelic agent in your project `yarn add newrelic`
+   */
+  apm: () => {},
   tracer: () => require('../opentelemetry')
 };
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();

package/dist/commercetools-ts-sdk-apm.browser.esm.js

@@ -3,17 +3,23 @@
  * opentelemetry tracer modules
  */
 const defaultOptions = {
-  apm: () => require('newrelic'),
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   * Note: don't forget to install newrelic agent in your project `yarn add newrelic`
+   */
+  apm: () => {},
   tracer: () => require('../opentelemetry')
 };
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();

package/dist/commercetools-ts-sdk-apm.cjs.d.ts

@@ -1,2 +1,2 @@
-export * from "./declarations/src/index";
-//# sourceMappingURL=commercetools-ts-sdk-apm.cjs.d.ts.map
+export * from "./declarations/src/index.js";
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tbWVyY2V0b29scy10cy1zZGstYXBtLmNqcy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi9kZWNsYXJhdGlvbnMvc3JjL2luZGV4LmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEifQ==

package/dist/commercetools-ts-sdk-apm.cjs.dev.js

@@ -7,17 +7,23 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * opentelemetry tracer modules
  */
 const defaultOptions = {
-  apm: () => require('newrelic'),
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   * Note: don't forget to install newrelic agent in your project `yarn add newrelic`
+   */
+  apm: () => {},
   tracer: () => require('../opentelemetry')
 };
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();

package/dist/commercetools-ts-sdk-apm.cjs.prod.js

@@ -7,17 +7,23 @@ Object.defineProperty(exports, '__esModule', { value: true });
  * opentelemetry tracer modules
  */
 const defaultOptions = {
-  apm: () => require('newrelic'),
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   * Note: don't forget to install newrelic agent in your project `yarn add newrelic`
+   */
+  apm: () => {},
   tracer: () => require('../opentelemetry')
 };
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();

package/dist/commercetools-ts-sdk-apm.esm.js

@@ -3,17 +3,23 @@
  * opentelemetry tracer modules
  */
 const defaultOptions = {
-  apm: () => require('newrelic'),
+  /**
+   * if this is to be used with newrelic, then
+   * pass this (apm) as an option in the `createTelemetryMiddleware`
+   * function e.g createTelemetryMiddleware({ apm: () => require('newrelic'), ... })
+   * Note: don't forget to install newrelic agent in your project `yarn add newrelic`
+   */
+  apm: () => {},
   tracer: () => require('../opentelemetry')
 };
 function createTelemetryMiddleware(options) {
   // trace
   function trace() {
     // validate apm and tracer
-    if (!(options !== null && options !== void 0 && options.apm && typeof options.apm == 'function')) {
+    if (!(options?.apm && typeof options.apm == 'function')) {
       options.apm = defaultOptions.apm;
     }
-    if (!(options !== null && options !== void 0 && options.tracer && typeof options.tracer == 'function')) {
+    if (!(options?.tracer && typeof options.tracer == 'function')) {
       options.tracer = defaultOptions.tracer;
     }
     options.apm();

package/dist/declarations/src/apm.d.ts

@@ -1,2 +1,3 @@
 import type { Middleware, OTelemetryMiddlewareOptions } from "../types/types.js";
 export default function createTelemetryMiddleware(options: OTelemetryMiddlewareOptions): Middleware;
+//# sourceMappingURL=apm.d.ts.map

package/dist/declarations/src/apm.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apm.d.ts","sourceRoot":"../../../src","sources":["apm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EAIV,2BAA2B,EAC5B,0BAAsB;AAiBvB,MAAM,CAAC,OAAO,UAAU,yBAAyB,CAC/C,OAAO,EAAE,2BAA2B,GACnC,UAAU,CA0BZ"}

package/dist/declarations/src/index.d.ts

@@ -1,2 +1,3 @@
 export * from "../types/types.js";
 export { default as createTelemetryMiddleware } from "./apm.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/declarations/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"../../../src","sources":["index.ts"],"names":[],"mappings":"AAAA,kCAAgC;AAChC,OAAO,EAAE,OAAO,IAAI,yBAAyB,EAAE,iBAAa"}

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

@@ -95,8 +95,9 @@ export type MethodType =
   | 'UNSUBSCRIBE'
 
 export type TelemetryMiddlewareOptions = {
-  apm?: Function,
-  tracer?: Function,
+  apm?: Function;
+  tracer?: Function;
+  userAgent?: string;
   createTelemetryMiddleware: (options?: OTelemetryMiddlewareOptions) => Middleware
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@commercetools/ts-sdk-apm",
-  "version": "1.0.2",
+  "version": "3.0.0",
   "description": "commercetools typescript SDK application performance monitoring.",
   "main": "dist/commercetools-ts-sdk-apm.cjs.js",
   "module": "dist/commercetools-ts-sdk-apm.esm.js",
@@ -9,17 +9,16 @@
   "private": false,
   "dependencies": {
     "@opentelemetry/api": "^1.4.1",
-    "@opentelemetry/auto-instrumentations-node": "^0.38.0",
-    "@opentelemetry/exporter-metrics-otlp-http": "^0.41.0",
-    "@opentelemetry/sdk-node": "^0.41.0",
-    "newrelic": "^10.0.0",
-    "uuid": "9.0.0"
+    "@opentelemetry/auto-instrumentations-node": "^0.52.0",
+    "@opentelemetry/exporter-metrics-otlp-http": "^0.54.0",
+    "@opentelemetry/sdk-node": "^0.54.0",
+    "uuid": "11.0.3"
   },
   "publishConfig": {
     "access": "public"
   },
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "keywords": [
     "commercetools",

package/dist/commercetools-ts-sdk-apm.cjs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"commercetools-ts-sdk-apm.cjs.d.ts","sourceRoot":"","sources":["./declarations/src/index.d.ts"],"names":[],"mappings":"AAAA"}