feat(node): pino integration

dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts

@@ -53,6 +53,7 @@ const DEPENDENTS: Dependent[] = [
       'NODE_VERSION',
       'childProcessIntegration',
       'systemErrorIntegration',
+      'pinoIntegration',
     ],
   },
   {

dev-packages/node-integration-tests/package.json

@@ -64,6 +64,7 @@
     "node-schedule": "^2.1.1",
     "openai": "5.18.1",
     "pg": "8.16.0",
+    "pino": "9.9.4",
     "postgres": "^3.4.7",
     "prisma": "6.15.0",
     "proxy": "^2.1.1",

dev-packages/node-integration-tests/suites/pino/instrument.mjs

@@ -0,0 +1,8 @@
+import * as Sentry from '@sentry/node';
+
+Sentry.init({
+  dsn: process.env.SENTRY_DSN,
+  release: '1.0',
+  enableLogs: true,
+  integrations: [Sentry.pinoIntegration({ error: { levels: ['error', 'fatal'] } })],
+});

dev-packages/node-integration-tests/suites/pino/scenario.mjs

@@ -0,0 +1,18 @@
+import * as Sentry from '@sentry/node';
+import pino from 'pino';
+
+const logger = pino({});
+
+Sentry.withIsolationScope(() => {
+  Sentry.startSpan({ name: 'startup' }, () => {
+    logger.info({ user: 'user-id', something: { more: 3, complex: 'nope' } }, 'hello world');
+  });
+});
+
+setTimeout(() => {
+  Sentry.withIsolationScope(() => {
+    Sentry.startSpan({ name: 'later' }, () => {
+      logger.error(new Error('oh no'));
+    });
+  });
+}, 1000);

dev-packages/node-integration-tests/suites/pino/test.ts

@@ -0,0 +1,99 @@
+import { join } from 'path';
+import { expect, test } from 'vitest';
+import { conditionalTest } from '../../utils';
+import { createRunner } from '../../utils/runner';
+
+conditionalTest({ min: 20 })('Pino integration', () => {
+  test('has different trace ids for logs from different spans', async () => {
+    const instrumentPath = join(__dirname, 'instrument.mjs');
+
+    await createRunner(__dirname, 'scenario.mjs')
+      .withMockSentryServer()
+      .withInstrument(instrumentPath)
+      .ignore('event')
+      .expect({
+        log: log => {
+          const traceId1 = log.items?.[0]?.trace_id;
+          const traceId2 = log.items?.[1]?.trace_id;
+          expect(traceId1).not.toBe(traceId2);
+        },
+      })
+      .start()
+      .completed();
+  });
+
+  test('captures event and logs', async () => {
+    // expect.assertions(1);
+    const instrumentPath = join(__dirname, 'instrument.mjs');
+
+    await createRunner(__dirname, 'scenario.mjs')
+      .withMockSentryServer()
+      .withInstrument(instrumentPath)
+      .expect({
+        event: {
+          exception: {
+            values: [
+              {
+                type: 'Error',
+                value: 'oh no',
+                mechanism: {
+                  type: 'pino',
+                  handled: true,
+                },
+                stacktrace: {
+                  frames: expect.arrayContaining([
+                    expect.objectContaining({
+                      function: '?',
+                      in_app: true,
+                      module: 'scenario',
+                      context_line: "      logger.error(new Error('oh no'));",
+                    }),
+                  ]),
+                },
+              },
+            ],
+          },
+        },
+      })
+      .expect({
+        log: {
+          items: [
+            {
+              timestamp: expect.any(Number),
+              level: 'info',
+              body: 'hello world',
+              trace_id: expect.any(String),
+              severity_number: 9,
+              attributes: expect.objectContaining({
+                'sentry.origin': { value: 'auto.logging.pino', type: 'string' },
+                'sentry.pino.level': { value: 30, type: 'integer' },
+                user: { value: 'user-id', type: 'string' },
+                something: {
+                  type: 'string',
+                  value: '{"more":3,"complex":"nope"}',
+                },
+                'sentry.release': { value: '1.0', type: 'string' },
+                'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
+              }),
+            },
+            {
+              timestamp: expect.any(Number),
+              level: 'error',
+              body: 'oh no',
+              trace_id: expect.any(String),
+              severity_number: 17,
+              attributes: expect.objectContaining({
+                'sentry.origin': { value: 'auto.logging.pino', type: 'string' },
+                'sentry.pino.level': { value: 50, type: 'integer' },
+                err: { value: '{}', type: 'string' },
+                'sentry.release': { value: '1.0', type: 'string' },
+                'sentry.sdk.name': { value: 'sentry.javascript.node', type: 'string' },
+              }),
+            },
+          ],
+        },
+      })
+      .start()
+      .completed();
+  });
+});

packages/astro/src/index.server.ts

@@ -91,6 +91,7 @@ export {
   onUnhandledRejectionIntegration,
   openAIIntegration,
   parameterize,
+  pinoIntegration,
   postgresIntegration,
   postgresJsIntegration,
   prismaIntegration,

packages/aws-serverless/src/index.ts

@@ -104,6 +104,7 @@ export {
   mysql2Integration,
   redisIntegration,
   tediousIntegration,
+  pinoIntegration,
   postgresIntegration,
   postgresJsIntegration,
   prismaIntegration,

packages/core/src/utils/worldwide.ts

@@ -48,6 +48,8 @@ export type InternalGlobal = {
    */
   _sentryModuleMetadata?: Record<string, any>;
   _sentryEsmLoaderHookRegistered?: boolean;
+  _sentryInjectLoaderHookRegister?: () => void;
+  _sentryInjectLoaderHookRegistered?: boolean;
 } & Carrier;
 
 /** Get's the global object for the current JavaScript runtime */

packages/google-cloud-serverless/src/index.ts

@@ -104,6 +104,7 @@ export {
   mysql2Integration,
   redisIntegration,
   tediousIntegration,
+  pinoIntegration,
   postgresIntegration,
   postgresJsIntegration,
   prismaIntegration,

packages/node-core/package.json

@@ -66,11 +66,13 @@
     "@opentelemetry/semantic-conventions": "^1.37.0"
   },
   "dependencies": {
+    "@apm-js-collab/tracing-hooks": "^0.3.0",
     "@sentry/core": "10.12.0",
     "@sentry/opentelemetry": "10.12.0",
     "import-in-the-middle": "^1.14.2"
   },
   "devDependencies": {
+    "@apm-js-collab/code-transformer": "^0.8.0",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^2.1.0",
     "@opentelemetry/core": "^2.1.0",

packages/node-core/src/index.ts

@@ -24,6 +24,7 @@ export { spotlightIntegration } from './integrations/spotlight';
 export { systemErrorIntegration } from './integrations/systemError';
 export { childProcessIntegration } from './integrations/childProcess';
 export { createSentryWinstonTransport } from './integrations/winston';
+export { pinoIntegration } from './integrations/pino';
 
 export { SentryContextManager } from './otel/contextManager';
 export { setupOpenTelemetryLogger } from './otel/logger';

packages/node-core/src/integrations/pino.ts

@@ -0,0 +1,149 @@
+import { tracingChannel } from 'node:diagnostics_channel';
+import type { IntegrationFn, LogSeverityLevel } from '@sentry/core';
+import {
+  _INTERNAL_captureLog,
+  addExceptionMechanism,
+  captureException,
+  captureMessage,
+  defineIntegration,
+  severityLevelFromString,
+  withScope,
+} from '@sentry/core';
+import { addInstrumentationConfig } from '../sdk/injectLoader';
+
+type LevelMapping = {
+  // Fortunately pino uses the same levels as Sentry
+  labels: { [level: number]: LogSeverityLevel };
+};
+
+type Pino = {
+  levels: LevelMapping;
+};
+
+type MergeObject = {
+  [key: string]: unknown;
+  err?: Error;
+};
+
+type PinoHookArgs = [MergeObject, string, number];
+
+type PinoOptions = {
+  error: {
+    /**
+     * Levels that trigger capturing of events.
+     *
+     * @default []
+     */
+    levels: LogSeverityLevel[];
+    /**
+     * By default, Sentry will mark captured errors as handled.
+     * Set this to `false` if you want to mark them as unhandled instead.
+     *
+     * @default true
+     */
+    handled: boolean;
+  };
+  log: {
+    /**
+     * Levels that trigger capturing of logs. Logs are only captured if
+     * `enableLogs` is enabled.
+     *
+     * @default ["trace", "debug", "info", "warn", "error", "fatal"]
+     */
+    levels: LogSeverityLevel[];
+  };
+};
+
+const DEFAULT_OPTIONS: PinoOptions = {
+  error: { levels: [], handled: true },
+  log: { levels: ['trace', 'debug', 'info', 'warn', 'error', 'fatal'] },
+};
+
+type DeepPartial<T> = {
+  [P in keyof T]?: T[P] extends object ? Partial<T[P]> : T[P];
+};
+
+/**
+ * Integration for Pino logging library.
+ * Captures Pino logs as Sentry logs and optionally captures some log levels as events.
+ *
+ * Requires Pino >=v8.0.0 and Node >=20.6.0 or >=18.19.0
+ */
+export const pinoIntegration = defineIntegration((userOptions: DeepPartial<PinoOptions> = {}) => {
+  const options: PinoOptions = {
+    error: { ...DEFAULT_OPTIONS.error, ...userOptions.error },
+    log: { ...DEFAULT_OPTIONS.log, ...userOptions.log },
+  };
+
+  return {
+    name: 'Pino',
+    setup: client => {
+      const enableLogs = !!client.getOptions().enableLogs;
+
+      addInstrumentationConfig({
+        channelName: 'pino-log',
+        // From Pino v9.10.0 a tracing channel is available directly from Pino:
+        // https://github.com/pinojs/pino/pull/2281
+        module: { name: 'pino', versionRange: '>=8.0.0 < 9.10.0', filePath: 'lib/tools.js' },
+        functionQuery: {
+          functionName: 'asJson',
+          kind: 'Sync',
+        },
+      });
+
+      const injectedChannel = tracingChannel('orchestrion:pino:pino-log');
+      const integratedChannel = tracingChannel('tracing:pino_asJson');
+
+      function onPinoStart(self: Pino, args: PinoHookArgs): void {
+        const [obj, message, levelNumber] = args;
+        const level = self?.levels?.labels?.[levelNumber] || 'info';
+
+        const attributes = {
+          ...obj,
+          'sentry.origin': 'auto.logging.pino',
+          'sentry.pino.level': levelNumber,
+        };
+
+        if (enableLogs && options.log.levels.includes(level)) {
+          _INTERNAL_captureLog({ level, message, attributes });
+        }
+
+        if (options.error.levels.includes(level)) {
+          const captureContext = {
+            level: severityLevelFromString(level),
+          };
+
+          withScope(scope => {
+            scope.addEventProcessor(event => {
+              event.logger = 'pino';
+
+              addExceptionMechanism(event, {
+                handled: options.error.handled,
+                type: 'pino',
+              });
+
+              return event;
+            });
+
+            if (obj.err) {
+              captureException(obj.err, captureContext);
+              return;
+            }
+
+            captureMessage(message, captureContext);
+          });
+        }
+      }
+
+      injectedChannel.start.subscribe(data => {
+        const { self, arguments: args } = data as { self: Pino; arguments: PinoHookArgs };
+        onPinoStart(self, args);
+      });
+
+      integratedChannel.start.subscribe(data => {
+        const { instance, arguments: args } = data as { instance: Pino; arguments: PinoHookArgs };
+        onPinoStart(instance, args);
+      });
+    },
+  };
+}) satisfies IntegrationFn;

packages/node-core/src/sdk/apm-js-collab-tracing-hooks.d.ts

@@ -0,0 +1,11 @@
+declare module '@apm-js-collab/tracing-hooks' {
+  import type { InstrumentationConfig } from '@apm-js-collab/code-transformer';
+
+  type PatchConfig = { instrumentations: InstrumentationConfig[] };
+
+  /** Hooks require */
+  export default class ModulePatch {
+    public constructor(config: PatchConfig): ModulePatch;
+    public patch(): void;
+  }
+}

packages/node-core/src/sdk/index.ts

@@ -7,6 +7,7 @@ import {
   functionToStringIntegration,
   getCurrentScope,
   getIntegrationsToSetup,
+  GLOBAL_OBJ,
   hasSpansEnabled,
   inboundFiltersIntegration,
   linkedErrorsIntegration,
@@ -131,6 +132,8 @@ function _init(
 
   client.init();
 
+  GLOBAL_OBJ._sentryInjectLoaderHookRegister?.();
+
   debug.log(`SDK initialized from ${isCjs() ? 'CommonJS' : 'ESM'}`);
 
   client.startClientReportTracking();