@sentry/node

Variables

• defaultIntegrations
• Integrations
• SDK_NAME

Functions

• close()
• deepReadDirSync()
• flush()
• getSentryRelease()
• init()
• lastEventId()

Classes

• NodeBackend

  • eventFromException()
  • eventFromMessage()
• NodeClient

  • captureEvent()
  • captureException()
  • close()
  • initSessionFlusher()

Interfaces

• NodeOptions

  • caCerts
  • frameContextLines
  • httpProxy
  • httpsProxy
  • onFatalError()
  • serverName
  • shutdownTimeout

Namespaces

• Handlers

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

  • BaseTransport
  • HTTPSTransport
  • HTTPTransport

variable defaultIntegrations

const defaultIntegrations: any[];

variable Integrations

const Integrations: {
    Console: typeof NodeIntegrations.Console;
    Http: typeof NodeIntegrations.Http;
    OnUncaughtException: typeof NodeIntegrations.OnUncaughtException;
    OnUnhandledRejection: typeof NodeIntegrations.OnUnhandledRejection;
    LinkedErrors: typeof NodeIntegrations.LinkedErrors;
    Modules: typeof NodeIntegrations.Modules;
    FunctionToString: any;
    InboundFilters: any;
};

variable SDK_NAME

const SDK_NAME: string;

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 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.