@unito/integration-sdk 5.1.0 → 5.1.1

package/dist/src/index.cjs

@@ -4,6 +4,7 @@ var integrationApi = require('@unito/integration-api');
 var cachette = require('cachette');
 var crypto = require('crypto');
 var util = require('util');
+var tracer = require('dd-trace');
 var express = require('express');
 var busboy = require('busboy');
 var fs = require('fs');
@@ -299,6 +300,51 @@ function create(redisUrl) {
 }
 const Cache = { create };
 
+if (process.env.NODE_ENV === 'production' && process.env.DD_TRACE_ENABLED === 'true') {
+    // List of options available to the tracer: https://datadoghq.dev/dd-trace-js/interfaces/export_.TracerOptions.html
+    const apmConfig = { logInjection: false, profiling: false, sampleRate: 0 };
+    if (process.env.DD_APM_ENABLED == 'true') {
+        apmConfig.logInjection = true;
+        apmConfig.sampleRate = 1;
+    }
+    else {
+        // The "enable tracing" boolean is not exposed as part of the TracerOptions so we
+        // have to do so through env vars. Setting here instead of in services' config
+        // to avoid too many env vars to "flip" when enabling / disabling APM.
+        process.env.DD_TRACING_ENABLED = 'false';
+    }
+    // Profiling is extra $$$ so we're setting it as an "extra" when needed
+    if (process.env.DD_APM_PROFILING_ENABLED == 'true') {
+        apmConfig.profiling = true;
+    }
+    const tags = {};
+    // Using DD_TRACE_AGENT_URL as a hack to know if we're running inside of Kubernetes
+    // since this variable is not needed in Elastic Beanstalk of Lambda
+    if (process.env.DD_TRACE_AGENT_URL) {
+        tags.pod_name = process.env.HOSTNAME;
+    }
+    tracer.init({
+        ...apmConfig, // Conditionally enable APM tracing & profiling
+        runtimeMetrics: true, // Always enable runtime metrics https://docs.datadoghq.com/tracing/metrics/runtime_metrics/nodejs/?tab=environmentvariables
+        tags,
+    }); // initialized in a different file to avoid hoisting.
+}
+/**
+ * WARNING to projects importing this
+ * Even if dd-tracer documents that instrumentation happens at **.init() time**
+ * (see https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/#import-and-initialize-the-tracer ),
+ *   1. dd-tracer has no choice but to do some stuff **at import time**
+ *   2. dd-tracer is not exempt from bugs, like https://github.com/DataDog/dd-trace-js/issues/5211
+ *
+ * So, do not assume that dd-trace is *fully off* by default! Some of it runs!
+ * If you want to entirely disable all of dd-trace (e.g. during unit tests),
+ * then you must set `DD_TRACE_ENABLED=false`
+ *
+ * Q: Why not move the dd-trace import inside the `if DD_TRACE_ENABLED` condition, then?
+ * A: Because the future is ESM, and ESM imports must be static and top-level.
+ */
+const DD_TRACER = tracer;
+
 /**
  * Error class meant to be returned by integrations in case of exceptions. These errors will be caught and handled
  * appropriately. Any other error would result in an unhandled server error accompanied by a 500 status code.
@@ -1062,6 +1108,7 @@ function onHealthCheck(_req, res) {
     res.status(200).json({});
 }
 
+// Must be the very first import so dd-trace instruments all subsequent modules.
 function printErrorMessage(message) {
     console.error();
     console.error(`\x1b[31m Oops! Something went wrong! \x1b[0m`);
@@ -1830,6 +1877,7 @@ function buildCollectionQueryParams(params) {
 
 exports.Api = integrationApi__namespace;
 exports.Cache = Cache;
+exports.DD_TRACER = DD_TRACER;
 exports.Handler = Handler;
 exports.HttpErrors = httpErrors;
 exports.Integration = Integration;

package/dist/src/index.d.ts

@@ -11,3 +11,4 @@ export * as HttpErrors from './httpErrors.js';
 export { buildCollectionQueryParams, getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
 export { type default as Logger, NULL_LOGGER } from './resources/logger.js';
+export { DD_TRACER } from './resources/tracer.js';

package/dist/src/index.js

@@ -9,4 +9,5 @@ export * as HttpErrors from './httpErrors.js';
 export { buildCollectionQueryParams, getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
 export { NULL_LOGGER } from './resources/logger.js';
+export { DD_TRACER } from './resources/tracer.js';
 /* c8 ignore stop */

package/dist/src/integration.d.ts

@@ -1,3 +1,4 @@
+import './resources/tracer.js';
 import { HandlersInput } from './handler.js';
 type Options = {
     port?: number;

package/dist/src/integration.js

@@ -1,3 +1,5 @@
+// Must be the very first import so dd-trace instruments all subsequent modules.
+import './resources/tracer.js';
 import express from 'express';
 import { InvalidHandler } from './errors.js';
 import { Handler } from './handler.js';

package/dist/src/resources/tracer.d.ts

@@ -0,0 +1,16 @@
+import tracer from 'dd-trace';
+/**
+ * WARNING to projects importing this
+ * Even if dd-tracer documents that instrumentation happens at **.init() time**
+ * (see https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/#import-and-initialize-the-tracer ),
+ *   1. dd-tracer has no choice but to do some stuff **at import time**
+ *   2. dd-tracer is not exempt from bugs, like https://github.com/DataDog/dd-trace-js/issues/5211
+ *
+ * So, do not assume that dd-trace is *fully off* by default! Some of it runs!
+ * If you want to entirely disable all of dd-trace (e.g. during unit tests),
+ * then you must set `DD_TRACE_ENABLED=false`
+ *
+ * Q: Why not move the dd-trace import inside the `if DD_TRACE_ENABLED` condition, then?
+ * A: Because the future is ESM, and ESM imports must be static and top-level.
+ */
+export declare const DD_TRACER: tracer.Tracer;

package/dist/src/resources/tracer.js

@@ -0,0 +1,45 @@
+import tracer from 'dd-trace';
+if (process.env.NODE_ENV === 'production' && process.env.DD_TRACE_ENABLED === 'true') {
+    // List of options available to the tracer: https://datadoghq.dev/dd-trace-js/interfaces/export_.TracerOptions.html
+    const apmConfig = { logInjection: false, profiling: false, sampleRate: 0 };
+    if (process.env.DD_APM_ENABLED == 'true') {
+        apmConfig.logInjection = true;
+        apmConfig.sampleRate = 1;
+    }
+    else {
+        // The "enable tracing" boolean is not exposed as part of the TracerOptions so we
+        // have to do so through env vars. Setting here instead of in services' config
+        // to avoid too many env vars to "flip" when enabling / disabling APM.
+        process.env.DD_TRACING_ENABLED = 'false';
+    }
+    // Profiling is extra $$$ so we're setting it as an "extra" when needed
+    if (process.env.DD_APM_PROFILING_ENABLED == 'true') {
+        apmConfig.profiling = true;
+    }
+    const tags = {};
+    // Using DD_TRACE_AGENT_URL as a hack to know if we're running inside of Kubernetes
+    // since this variable is not needed in Elastic Beanstalk of Lambda
+    if (process.env.DD_TRACE_AGENT_URL) {
+        tags.pod_name = process.env.HOSTNAME;
+    }
+    tracer.init({
+        ...apmConfig, // Conditionally enable APM tracing & profiling
+        runtimeMetrics: true, // Always enable runtime metrics https://docs.datadoghq.com/tracing/metrics/runtime_metrics/nodejs/?tab=environmentvariables
+        tags,
+    }); // initialized in a different file to avoid hoisting.
+}
+/**
+ * WARNING to projects importing this
+ * Even if dd-tracer documents that instrumentation happens at **.init() time**
+ * (see https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/#import-and-initialize-the-tracer ),
+ *   1. dd-tracer has no choice but to do some stuff **at import time**
+ *   2. dd-tracer is not exempt from bugs, like https://github.com/DataDog/dd-trace-js/issues/5211
+ *
+ * So, do not assume that dd-trace is *fully off* by default! Some of it runs!
+ * If you want to entirely disable all of dd-trace (e.g. during unit tests),
+ * then you must set `DD_TRACE_ENABLED=false`
+ *
+ * Q: Why not move the dd-trace import inside the `if DD_TRACE_ENABLED` condition, then?
+ * A: Because the future is ESM, and ESM imports must be static and top-level.
+ */
+export const DD_TRACER = tracer;

package/dist/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"root":["../src/errors.ts","../src/handler.ts","../src/helpers.ts","../src/httpErrors.ts","../src/index.ts","../src/integration.ts","../src/middlewares/correlationId.ts","../src/middlewares/credentials.ts","../src/middlewares/errors.ts","../src/middlewares/filters.ts","../src/middlewares/finish.ts","../src/middlewares/health.ts","../src/middlewares/logger.ts","../src/middlewares/notFound.ts","../src/middlewares/relations.ts","../src/middlewares/search.ts","../src/middlewares/secrets.ts","../src/middlewares/selects.ts","../src/middlewares/signal.ts","../src/middlewares/start.ts","../src/resources/cache.ts","../src/resources/context.ts","../src/resources/logger.ts","../src/resources/provider.ts","../src/resources/requestMetrics.ts","../test/errors.test.ts","../test/handler.test.ts","../test/helpers.test.ts","../test/integration.test.ts","../test/middlewares/correlationId.test.ts","../test/middlewares/credentials.test.ts","../test/middlewares/errors.test.ts","../test/middlewares/filters.test.ts","../test/middlewares/finish.test.ts","../test/middlewares/health.test.ts","../test/middlewares/logger.test.ts","../test/middlewares/notFound.test.ts","../test/middlewares/relations.test.ts","../test/middlewares/search.test.ts","../test/middlewares/secrets.test.ts","../test/middlewares/selects.test.ts","../test/middlewares/signal.test.ts","../test/middlewares/start.test.ts","../test/resources/cache.test.ts","../test/resources/logger.test.ts","../test/resources/provider.test.ts","../test/resources/requestMetrics.test.ts"],"version":"5.9.3"}
+{"root":["../src/errors.ts","../src/handler.ts","../src/helpers.ts","../src/httpErrors.ts","../src/index.ts","../src/integration.ts","../src/middlewares/correlationId.ts","../src/middlewares/credentials.ts","../src/middlewares/errors.ts","../src/middlewares/filters.ts","../src/middlewares/finish.ts","../src/middlewares/health.ts","../src/middlewares/logger.ts","../src/middlewares/notFound.ts","../src/middlewares/relations.ts","../src/middlewares/search.ts","../src/middlewares/secrets.ts","../src/middlewares/selects.ts","../src/middlewares/signal.ts","../src/middlewares/start.ts","../src/resources/cache.ts","../src/resources/context.ts","../src/resources/logger.ts","../src/resources/provider.ts","../src/resources/requestMetrics.ts","../src/resources/tracer.ts","../test/errors.test.ts","../test/handler.test.ts","../test/helpers.test.ts","../test/integration.test.ts","../test/middlewares/correlationId.test.ts","../test/middlewares/credentials.test.ts","../test/middlewares/errors.test.ts","../test/middlewares/filters.test.ts","../test/middlewares/finish.test.ts","../test/middlewares/health.test.ts","../test/middlewares/logger.test.ts","../test/middlewares/notFound.test.ts","../test/middlewares/relations.test.ts","../test/middlewares/search.test.ts","../test/middlewares/secrets.test.ts","../test/middlewares/selects.test.ts","../test/middlewares/signal.test.ts","../test/middlewares/start.test.ts","../test/resources/cache.test.ts","../test/resources/logger.test.ts","../test/resources/provider.test.ts","../test/resources/requestMetrics.test.ts"],"version":"5.9.3"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unito/integration-sdk",
-  "version": "5.1.0",
+  "version": "5.1.1",
   "description": "Integration SDK",
   "type": "module",
   "types": "dist/src/index.d.ts",
@@ -56,6 +56,7 @@
     "@unito/integration-api": "7.x",
     "busboy": "^1.6.0",
     "cachette": "4.x",
+    "dd-trace": "5.x",
     "express": "^5.1",
     "form-data": "^4.0.0"
   },

package/src/index.ts

@@ -18,4 +18,5 @@ export * as HttpErrors from './httpErrors.js';
 export { buildCollectionQueryParams, getApplicableFilters } from './helpers.js';
 export * from './resources/context.js';
 export { type default as Logger, NULL_LOGGER } from './resources/logger.js';
+export { DD_TRACER } from './resources/tracer.js';
 /* c8 ignore stop */

package/src/integration.ts

@@ -1,3 +1,6 @@
+// Must be the very first import so dd-trace instruments all subsequent modules.
+import './resources/tracer.js';
+
 import { Server, IncomingMessage, ServerResponse } from 'http';
 import express from 'express';
 

package/src/resources/tracer.ts

@@ -0,0 +1,50 @@
+import tracer, { TracerOptions } from 'dd-trace';
+
+if (process.env.NODE_ENV === 'production' && process.env.DD_TRACE_ENABLED === 'true') {
+  // List of options available to the tracer: https://datadoghq.dev/dd-trace-js/interfaces/export_.TracerOptions.html
+  const apmConfig: TracerOptions = { logInjection: false, profiling: false, sampleRate: 0 };
+
+  if (process.env.DD_APM_ENABLED == 'true') {
+    apmConfig.logInjection = true;
+    apmConfig.sampleRate = 1;
+  } else {
+    // The "enable tracing" boolean is not exposed as part of the TracerOptions so we
+    // have to do so through env vars. Setting here instead of in services' config
+    // to avoid too many env vars to "flip" when enabling / disabling APM.
+    process.env.DD_TRACING_ENABLED = 'false';
+  }
+
+  // Profiling is extra $$$ so we're setting it as an "extra" when needed
+  if (process.env.DD_APM_PROFILING_ENABLED == 'true') {
+    apmConfig.profiling = true;
+  }
+
+  const tags: { [key: string]: any } = {};
+  // Using DD_TRACE_AGENT_URL as a hack to know if we're running inside of Kubernetes
+  // since this variable is not needed in Elastic Beanstalk of Lambda
+  if (process.env.DD_TRACE_AGENT_URL) {
+    tags.pod_name = process.env.HOSTNAME;
+  }
+
+  tracer.init({
+    ...apmConfig, // Conditionally enable APM tracing & profiling
+    runtimeMetrics: true, // Always enable runtime metrics https://docs.datadoghq.com/tracing/metrics/runtime_metrics/nodejs/?tab=environmentvariables
+    tags,
+  }); // initialized in a different file to avoid hoisting.
+}
+
+/**
+ * WARNING to projects importing this
+ * Even if dd-tracer documents that instrumentation happens at **.init() time**
+ * (see https://docs.datadoghq.com/tracing/trace_collection/automatic_instrumentation/dd_libraries/nodejs/#import-and-initialize-the-tracer ),
+ *   1. dd-tracer has no choice but to do some stuff **at import time**
+ *   2. dd-tracer is not exempt from bugs, like https://github.com/DataDog/dd-trace-js/issues/5211
+ *
+ * So, do not assume that dd-trace is *fully off* by default! Some of it runs!
+ * If you want to entirely disable all of dd-trace (e.g. during unit tests),
+ * then you must set `DD_TRACE_ENABLED=false`
+ *
+ * Q: Why not move the dd-trace import inside the `if DD_TRACE_ENABLED` condition, then?
+ * A: Because the future is ESM, and ESM imports must be static and top-level.
+ */
+export const DD_TRACER = tracer;