feat: update context for missing instrumentation

Author: chargome

dev-packages/e2e-tests/test-applications/node-express-incorrect-instrumentation/tests/instrumentation.test.ts

@@ -13,9 +13,8 @@ test('Sends correct context when instrumentation was set up incorrectly', async
   expect(errorEvent.exception?.values).toHaveLength(1);
   expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');
 
-  expect(errorEvent.contexts?.Instrumentation).toEqual({
-    isMissing: true,
+  expect(errorEvent.contexts?.missing_instrumentation).toEqual({
     package: 'express',
-    isCjs: true,
+    'javascript.is_cjs': true,
   });
 });

packages/node/src/integrations/context.ts

@@ -13,8 +13,10 @@ import type {
   DeviceContext,
   Event,
   IntegrationFn,
+  MissingInstrumentationContext,
   OsContext,
 } from '@sentry/types';
+import { isCjs } from '../utils/commonjs';
 
 export const readFileAsync = promisify(readFile);
 export const readDirAsync = promisify(readdir);
@@ -476,3 +478,8 @@ function getCloudResourceContext(): CloudResourceContext | undefined {
     return undefined;
   }
 }
+
+export const createMissingInstrumentationContext = (pkg: string): MissingInstrumentationContext => ({
+  package: pkg,
+  'javascript.is_cjs': isCjs(),
+});

packages/node/src/utils/ensureIsWrapped.ts

@@ -1,6 +1,7 @@
 import { isWrapped } from '@opentelemetry/core';
 import { getGlobalScope, hasTracingEnabled, isEnabled } from '@sentry/core';
 import { consoleSandbox } from '@sentry/utils';
+import { createMissingInstrumentationContext } from '../integrations/context';
 import { isCjs } from './commonjs';
 
 /**
@@ -25,10 +26,6 @@ export function ensureIsWrapped(
       }
     });
 
-    getGlobalScope().setContext('Instrumentation', {
-      isMissing: true,
-      package: name,
-      isCjs: isCjs(),
-    });
+    getGlobalScope().setContext('missing_instrumentation', createMissingInstrumentationContext(name));
   }
 }

packages/types/src/context.ts

@@ -119,3 +119,8 @@ export interface CloudResourceContext extends Record<string, unknown> {
 export interface ProfileContext extends Record<string, unknown> {
   profile_id: string;
 }
+
+export interface MissingInstrumentationContext extends Record<string, unknown> {
+  package: string;
+  ['javascript.is_cjs']?: boolean;
+}

packages/types/src/index.ts

@@ -18,6 +18,7 @@ export type {
   CultureContext,
   TraceContext,
   CloudResourceContext,
+  MissingInstrumentationContext,
 } from './context';
 export type { DataCategory } from './datacategory';
 export type { DsnComponents, DsnLike, DsnProtocol } from './dsn';