@sentry/profiling-node

Official Sentry Profiling SDK for NodeJS

Usage 🔥

import * as Sentry from '@sentry/node';
import '@sentry/tracing';
import { ProfilingIntegration } from '@sentry/profiling-node'.

Sentry.init({
  dsn: 'https://[e-mail]/6625302',
  debug: true,
  tracesSampleRate: 1,
  profilesSampleRate: 1, // Set sampling rate
  integrations: [new ProfilingIntegration()]
});

Sentry will automatically profile all transactions

const transaction = Sentry.startTransaction({ name: 'I will do some work' });

// The code between startTransaction and transaction.finish will be profiled

transaction.finish();

FAQ 💭

When should I not use this package

Todo: explain possible problems

Can the profiler leak PII to Sentry?

Todo: unlikely as we do not collect function arguments unless function calls are somehow created per user

What is the profiler overhead?

Todo: explain overhead and difference for kLazyLogging vs kEagerLogging

Will starting the profiler on main thread automatically profile worker threads too?

No, it will not (see WORKERS.md for an explanation)

What happens in the event of a profiler crash?

Todo: Check if napi will crash main process if worker is terminated while profiling. Todo: Check what happens if it crashes on main thread.