@sentry/node

Variables

• DEFAULT_USER_INCLUDES
• defaultIntegrations
• defaultStackParser
• Integrations

Functions

• addRequestDataToEvent()
• autoDiscoverNodePerformanceMonitoringIntegrations()
• close()
• deepReadDirSync()
• extractRequestData()
• flush()
• getSentryRelease()
• init()
• lastEventId()
• makeNodeTransport()

Classes

• NodeClient

  • captureEvent()
  • captureException()
  • close()
  • eventFromException()
  • eventFromMessage()
  • initSessionFlusher()

Interfaces

• NodeOptions

Type Aliases

• TransactionNamingScheme

Namespaces

• Handlers

  • errorHandler()
  • ExpressRequest
  • extractRequestData()
  • parseRequest()
  • ParseRequestOptions
  • requestHandler()
  • RequestHandlerOptions
  • tracingHandler()
  • trpcMiddleware()

variable DEFAULT_USER_INCLUDES

const DEFAULT_USER_INCLUDES: string[];

variable defaultIntegrations

const defaultIntegrations: any[];

variable defaultStackParser

const defaultStackParser: StackParser;

• Node.js stack parser

variable Integrations

const Integrations: {
    Apollo: any;
    Express: any;
    GraphQL: any;
    Mongo: any;
    Mysql: any;
    Postgres: any;
    Prisma: any;
    Console: typeof NodeIntegrations.Console;
    Http: typeof NodeIntegrations.Http;
    OnUncaughtException: typeof NodeIntegrations.OnUncaughtException;
    OnUnhandledRejection: typeof NodeIntegrations.OnUnhandledRejection;
    LinkedErrors: typeof NodeIntegrations.LinkedErrors;
    Modules: typeof NodeIntegrations.Modules;
    ContextLines: typeof NodeIntegrations.ContextLines;
    Context: typeof NodeIntegrations.Context;
    RequestData: typeof NodeIntegrations.RequestData;
    LocalVariables: typeof NodeIntegrations.LocalVariables;
    Undici: typeof NodeIntegrations.Undici;
    FunctionToString: any;
    InboundFilters: any;
};

function addRequestDataToEvent

addRequestDataToEvent: (
    event: Event,
    req: PolymorphicRequest,
    options?: AddRequestDataToEventOptions
) => Event;

• Add data from the given request to the given event

  Parameter event

  The event to which the request data will be added

  Parameter req

  Request object

  Parameter

  options.include Flags to control what data is included

  Returns

  The mutated Event object

function autoDiscoverNodePerformanceMonitoringIntegrations

autoDiscoverNodePerformanceMonitoringIntegrations: () => Integration[];

• Automatically detects and returns integrations that will work with your dependencies.

function close

close: (timeout?: number) => Promise<boolean>;

• Call close() on the current client, if there is one. See Client.close.

  Parameter timeout

  Maximum time in ms the client should wait to flush its event queue before shutting down. Omitting this parameter will cause the client to wait until all events are sent before disabling itself.

  Returns

  A promise which resolves to true if the queue successfully drains before the timeout, or false if it doesn't (or if there's no client defined).

function deepReadDirSync

deepReadDirSync: (targetDir: string) => string[];

• Recursively read the contents of a directory.

  Parameter targetDir

  Absolute or relative path of the directory to scan. All returned paths will be relative to this directory.

  Returns

  Array holding all relative paths

function extractRequestData

extractRequestData: (
    req: PolymorphicRequest,
    options?: { include?: string[] }
) => ExtractedNodeRequestData;

• Normalize data from the request object

  Parameter req

  The request object from which to extract data

  Parameter

  options.include An optional array of keys to include in the normalized data. Defaults to DEFAULT_REQUEST_INCLUDES if not provided.

  Parameter

  options.deps Injected, platform-specific dependencies

  Returns

  An object containing normalized request data

function flush

flush: (timeout?: number) => Promise<boolean>;

• Call flush() on the current client, if there is one. See Client.flush.

  Parameter timeout

  Maximum time in ms the client should wait to flush its event queue. Omitting this parameter will cause the client to wait until all events are sent before resolving the promise.

  Returns

  A promise which resolves to true if the queue successfully drains before the timeout, or false if it doesn't (or if there's no client defined).

function getSentryRelease

getSentryRelease: (fallback?: string) => string | undefined;

• Returns a release dynamically from environment variables.

function init

init: (options?: NodeOptions) => void;

• The Sentry Node SDK Client.

  To use this SDK, call the init function as early as possible in the main entry module. To set context information or send manual events, use the provided methods.

  Example 1

  const { init } = require('@sentry/node');
  
  init({
    dsn: '__DSN__',
    // ...
  });

  Example 2

  const { configureScope } = require('@sentry/node');
  configureScope((scope: Scope) => {
    scope.setExtra({ battery: 0.7 });
    scope.setTag({ user_mode: 'admin' });
    scope.setUser({ id: '4711' });
  });

  Example 3

  const { addBreadcrumb } = require('@sentry/node');
  addBreadcrumb({
    message: 'My Breadcrumb',
    // ...
  });

  Example 4

  const Sentry = require('@sentry/node');
  Sentry.captureMessage('Hello, world!');
  Sentry.captureException(new Error('Good bye'));
  Sentry.captureEvent({
    message: 'Manual',
    stacktrace: [
      // ...
    ],
  });

  See Also

  • NodeOptions for documentation on configuration options.

function lastEventId

lastEventId: () => string | undefined;

• This is the getter for lastEventId.

  Returns

  The last event id of a captured event.

function makeNodeTransport

makeNodeTransport: (options: NodeTransportOptions) => Transport;

• Creates a Transport that uses native the native 'http' and 'https' modules to send events to Sentry.

type TransactionNamingScheme

type TransactionNamingScheme = 'path' | 'methodPath' | 'handler';