@contrast/telemetry 1.20.1 → 1.20.3

package/lib/index.js

@@ -30,17 +30,40 @@ const TELEMETRY_URL = 'https://telemetry.nodejs.contrastsecurity.com/';
 const TELEMETRY_VERSION = 'v0'; // TODO: set this to v1 when format is established.
 
 /**
- * @param {{
- *  agentName: string,
- *  agentVersion: string,
- *  appInfo: import('@contrast/common').AppInfo,
+ * @param {import("@contrast/core").Core} core
+ */
+async function getIds(core) {
+  const { Host: { Docker: { containerID: containerId } } } = await core.getSystemInfo();
+  let applicationId, instance;
+
+  try {
+    const hash = createHash('sha256').update(getMac());
+    if (containerId) hash.update(containerId);
+    instance = hash.copy().digest('hex');
+    applicationId = hash.update(core.appInfo.name).digest('hex');
+  } catch {
+    // If getMac fails we fall back to generating a UUID. "Unstable"
+    // identifiers such as these are prefixed with an underscore.
+    let id = randomUUID();
+    if (containerId) {
+      id += `_${containerId}`;
+    }
+    applicationId = instance = `_${id}`;
+  }
+
+  return { applicationId, containerId, instance };
+}
+
+/**
+ * @param {import('@contrast/core').Core & {
  *  config: import('@contrast/config').Config,
  *  logger: import('@contrast/logger').Logger,
  *  messages: import('@contrast/common').Messages,
+ *  telemetry?: import('@contrast/common').Installable
  * }} core
  * @returns {import('@contrast/common').Installable}
  */
-module.exports = function(core) {
+module.exports = function (core) {
   const {
     agentName,
     agentVersion,
@@ -50,58 +73,48 @@ module.exports = function(core) {
     messages,
   } = core;
 
-  const { instanceId, applicationId } = getIds(appInfo);
-
-  const telemetry = core.telemetry = {
-    /** @type {axios.AxiosInstance} */
-    client: null,
-    instanceId,
-    tags: {
-      applicationId,
-      isCustomerEnv: true,
-      osArch: appInfo.os.architecture,
-      osPlatform: appInfo.os.platform,
-      osRelease: appInfo.os.release,
-      isContainer: !!appInfo.containerId, // TODO: this is undefined
-      agent: agentName,
-      agentVersion,
-      isAssess: config.getEffectiveValue('assess.enable'),
-      isProtect: config.getEffectiveValue('protect.enable'),
-      nodeVersion: appInfo.nodeVersion,
-      telemetryVersion: TELEMETRY_VERSION,
-    },
-    isEnabled() {
-      return (
-        process.env.CONTRAST_AGENT_TELEMETRY_OPTOUT !== 'true' &&
-        process.env.CONTRAST_AGENT_TELEMETRY_OPTOUT !== '1'
-      );
-    },
-    install() {
-      if (!telemetry.isEnabled()) {
+  return core.telemetry = {
+    async install() {
+      if (
+        process.env.CONTRAST_AGENT_TELEMETRY_OPTOUT === 'true' ||
+        process.env.CONTRAST_AGENT_TELEMETRY_OPTOUT === '1'
+      ) {
         logger.info('Telemetry opt-out in effect. All usage data collection is suppressed.');
         return;
       }
 
       logger.info(DISCLAIMER);
 
-      telemetry.client = axios.create({
+      const { instance, containerId, applicationId } = await getIds(core);
+      const tags = {
+        applicationId,
+        isCustomerEnv: true,
+        osArch: appInfo.os.architecture,
+        osPlatform: appInfo.os.platform,
+        osRelease: appInfo.os.release,
+        isContainer: !!containerId,
+        agent: agentName,
+        agentVersion,
+        isAssess: config.getEffectiveValue('assess.enable'),
+        isProtect: config.getEffectiveValue('protect.enable'),
+        nodeVersion: appInfo.nodeVersion,
+        telemetryVersion: TELEMETRY_VERSION,
+      };
+
+      const client = axios.create({
         baseURL: new URL('/api/v1/telemetry/metrics/node', TELEMETRY_URL).href,
         headers: {
           'User-Agent': `${agentName}/${agentVersion}`,
         }
       });
 
-      telemetry.startup();
-    },
-
-    async startup() {
       try {
         const { external, heapTotal, heapUsed, rss } = process.memoryUsage();
-        await telemetry.client.post('/startup', [
+        await client.post('/startup', [
           {
             timestamp: new Date().toISOString(),
-            instance: telemetry.instanceId,
-            tags: telemetry.tags,
+            instance,
+            tags,
             fields: {
               numCpus: os.cpus().length,
               memTotal: os.totalmem(),
@@ -116,66 +129,41 @@ module.exports = function(core) {
       } catch (err) {
         logger.error({ err }, 'error occurred while reporting telemetry: /startup');
       }
-    },
-  };
 
-  messages.on(Event.SERVER_SETTINGS_UPDATE, () => {
-    telemetry.tags.isAssess = config.getEffectiveValue('assess.enable');
-    telemetry.tags.isProtect = config.getEffectiveValue('protect.enable');
-  });
-
-  let unsupportedLibs = [];
-  messages.on(Event.UNSUPPORTED_LIBRARY, (metadata) => {
-    unsupportedLibs.push({
-      timestamp: new Date().toISOString(),
-      instance: telemetry.instanceId,
-      tags: {
-        ...telemetry.tags,
-        name: metadata.name,
-        version: metadata.version,
-      },
-      fields: {
-        supported: 0
-      }
-    });
-  });
+      messages.on(Event.SERVER_SETTINGS_UPDATE, () => {
+        tags.isAssess = config.getEffectiveValue('assess.enable');
+        tags.isProtect = config.getEffectiveValue('protect.enable');
+      });
 
-  setInterval(async () => {
-    if (unsupportedLibs.length < 1) return;
+      let unsupportedLibs = [];
+      messages.on(Event.UNSUPPORTED_LIBRARY, (metadata) => {
+        unsupportedLibs.push({
+          timestamp: new Date().toISOString(),
+          instance,
+          tags: {
+            ...tags,
+            name: metadata.name,
+            version: metadata.version,
+          },
+          fields: {
+            supported: 0
+          }
+        });
+      });
 
-    try {
-      await telemetry.client.post('/dependencies', unsupportedLibs);
-    } catch (err) {
-      logger.error({ err }, 'error occurred while reporting telemetry: /dependencies');
-    }
+      setInterval(async () => {
+        if (unsupportedLibs.length < 1) return;
 
-    unsupportedLibs = [];
-  }, 20_000).unref();
+        try {
+          await client.post('/dependencies', unsupportedLibs);
+        } catch (err) {
+          logger.error({ err }, 'error occurred while reporting telemetry: /dependencies');
+        }
 
-  return core.telemetry;
+        unsupportedLibs = [];
+      }, 20_000).unref();
+    },
+  };
 };
 
-module.exports.getIds = getIds;
-
-function getIds (appInfo) {
-  let applicationId, instanceId;
-
-  try {
-    const hash = createHash('sha256').update(getMac());
-    if (appInfo.containerId) hash.update(appInfo.containerId);
-    instanceId = hash.copy().digest('hex');
-    applicationId = hash.update(appInfo.name).digest('hex');
-  } catch {
-    // If getMac fails we fall back to generating a UUID. "Unstable"
-    // identifiers such as these are prefixed with an underscore.
-    let id = randomUUID();
-    if (appInfo.containerId) {
-      id += `_${appInfo.containerId}`;
-    }
-    applicationId = instanceId = `_${id}`;
-  }
-
-  return { applicationId, instanceId };
-}
-
 module.exports.DISCLAIMER = DISCLAIMER;

package/package.json

@@ -1,9 +1,15 @@
 {
   "name": "@contrast/telemetry",
-  "version": "1.20.1",
+  "version": "1.20.3",
   "description": "Telemetry reporting for the Contrast Node.js agent.",
   "license": "SEE LICENSE IN LICENSE",
   "author": "Contrast Security <nodejs@contrastsecurity.com> (https://www.contrastsecurity.com)",
+  "files": [
+    "lib/",
+    "!*.test.*",
+    "!tsconfig.*",
+    "!*.map"
+  ],
   "main": "lib/index.js",
   "engines": {
     "npm": ">=6.13.7 <7 || >=8.3.1",
@@ -14,9 +20,9 @@
   },
   "dependencies": {
     "@contrast/common": "1.29.1",
-    "@contrast/config": "1.40.1",
-    "@contrast/core": "1.45.1",
-    "@contrast/logger": "1.18.1",
+    "@contrast/config": "1.40.2",
+    "@contrast/core": "1.45.2",
+    "@contrast/logger": "1.18.2",
     "axios": "^1.7.4",
     "getmac": "^6.3.0"
   }