@sentry/types

property crashed

crashed?: number;

property errored

errored?: number;

property exited

exited?: number;

property started

started: string;

property category

category?: string;

property data

data?: {
    [key: string]: any;
};

property event_id

event_id?: string;

property level

level?: Severity;

property message

message?: string;

property timestamp

timestamp?: number;

property type

type?: string;

index signature

[key: string]: any;

method captureEvent

captureEvent: (
    event: Event,
    hint?: EventHint,
    scope?: Scope
) => string | undefined;

• Captures a manually created event and sends it to Sentry.

  Parameter event

  The event to send to Sentry.

  Parameter hint

  May contain additional information about the original exception.

  Parameter scope

  An optional scope containing event metadata.

  Returns

  The event id

method captureException

captureException: (
    exception: any,
    hint?: EventHint,
    scope?: Scope
) => string | undefined;

• Captures an exception event and sends it to Sentry.

  Parameter exception

  An exception-like object.

  Parameter hint

  May contain additional information about the original exception.

  Parameter scope

  An optional scope containing event metadata.

  Returns

  The event id

method captureMessage

captureMessage: (
    message: string,
    level?: Severity,
    hint?: EventHint,
    scope?: Scope
) => string | undefined;

• Captures a message event and sends it to Sentry.

  Parameter message

  The message to send to Sentry.

  Parameter level

  Define the level of the message.

  Parameter hint

  May contain additional information about the original exception.

  Parameter scope

  An optional scope containing event metadata.

  Returns

  The event id

method captureSession

captureSession: (session: Session) => void;

• Captures a session

  Parameter session

  Session to be delivered

method close

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

• Flush the event queue and set the client to enabled = false. See Client.flush.

  Parameter timeout

  Maximum time in ms the client should wait 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 flush completes successfully before the timeout, or false if it doesn't.

method flush

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

• Wait for all events to be sent or the timeout to expire, whichever comes first.

  Parameter timeout

  Maximum time in ms the client should wait for events to be flushed. Omitting this parameter will cause the client to wait until all events are sent before resolving the promise.

  Returns

  A promise that will resolve with true if all events are sent before the timeout, or false if there are still events in the queue when the timeout is reached.

method getDsn

getDsn: () => Dsn | undefined;

• Returns the current Dsn.

method getIntegration

getIntegration: <T extends Integration>(
    integration: IntegrationClass<T>
) => T | null;

• Returns an array of installed integrations on the client.

method getOptions

getOptions: () => O;

• Returns the current options.

method setupIntegrations

setupIntegrations: () => void;

• This is an internal function to setup all integrations that should run on the client

index signature

[key: string]: any;

property code_file

code_file: string;

property code_id

code_id?: string | null;

property debug_file

debug_file?: string | null;

property debug_id

debug_id: string;

property type

type: DebugImageType;

property images

images?: Array<DebugImage>;

property transactionSampling

transactionSampling?: {
    rate?: number;
    method?: string;
};

method toString

toString: (withPassword: boolean) => string;

• Renders the string representation of this Dsn.

  By default, this will render the public representation without the password component. To get the deprecated private representation, set withPassword to true.

  Parameter withPassword

  When set to true, the password will be included.

property host

host: string;

• Hostname of the Sentry instance.

property pass

pass?: string;

• Private authorization key (deprecated, optional).

property path

path?: string;

• Sub path/

property port

port?: string;

• Port of the Sentry instance.

property projectId

projectId: string;

• Project ID

property protocol

protocol: DsnProtocol;

• Protocol used to connect to Sentry.

property publicKey

publicKey?: string;

• Public authorization key.

property user

user?: string;

• Public authorization key (deprecated, renamed to publicKey).

property breadcrumbs

breadcrumbs?: Breadcrumb[];

property contexts

contexts?: Contexts;

property debug_meta

debug_meta?: DebugMeta;

property dist

dist?: string;

property environment

environment?: string;

property event_id

event_id?: string;

property exception

exception?: {
    values?: Exception[];
};

property extra

extra?: Extras;

property fingerprint

fingerprint?: string[];

property level

level?: Severity;

property logger

logger?: string;

property measurements

measurements?: Measurements;

property message

message?: string;

property modules

modules?: {
    [key: string]: string;
};

property platform

platform?: string;

property release

release?: string;

property request

request?: Request;

property sdk

sdk?: SdkInfo;

property server_name

server_name?: string;

property spans

spans?: Span[];

property stacktrace

stacktrace?: Stacktrace;

property start_timestamp

start_timestamp?: number;

property tags

tags?: {
    [key: string]: Primitive;
};

property timestamp

timestamp?: number;

property transaction

transaction?: string;

property type

type?: EventType;

property user

user?: User;

property captureContext

captureContext?: CaptureContext;

property data

data?: any;

property event_id

event_id?: string;

property originalException

originalException?: Error | string | null;

property syntheticException

syntheticException?: Error | null;

property mechanism

mechanism?: Mechanism;

property module

module?: string;

property stacktrace

stacktrace?: Stacktrace;

property thread_id

thread_id?: number;

property type

type?: string;

property value

value?: string;

index signature

[key: string]: any;

property cookies

cookies?: {
    [key: string]: string;
};

• String representing the cookies sent along with the request

property data

data?: string;

• Any data sent in the request's body, as a JSON string

property headers

headers?: {
    [key: string]: string;
};

• Specific headers from the request

property method

method?: string;

• The request's method

property query_string

query_string?: QueryParams;

• The request's query params

property url

url?: string;

• The request's URL, including query string

index signature

[key: string]: any;

method addBreadcrumb

addBreadcrumb: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void;

• Records a new breadcrumb which will be attached to future events.

  Breadcrumbs will be added to subsequent events to provide more context on user's actions prior to an error or crash.

  Parameter breadcrumb

  The breadcrumb to record.

  Parameter hint

  May contain additional information about the original breadcrumb.

method bindClient

bindClient: (client?: Client) => void;

• This binds the given client to the current scope.

  Parameter client

  An SDK client (client) instance.

method captureEvent

captureEvent: (event: Event, hint?: EventHint) => string;

• Captures a manually created event and sends it to Sentry.

  Parameter event

  The event to send to Sentry.

  Parameter hint

  May contain additional information about the original exception.

method captureException

captureException: (exception: any, hint?: EventHint) => string;

• Captures an exception event and sends it to Sentry.

  Parameter exception

  An exception-like object.

  Parameter hint

  May contain additional information about the original exception.

  Returns

  The generated eventId.

method captureMessage

captureMessage: (message: string, level?: Severity, hint?: EventHint) => string;

• Captures a message event and sends it to Sentry.

  Parameter message

  The message to send to Sentry.

  Parameter level

  Define the level of the message.

  Parameter hint

  May contain additional information about the original exception.

  Returns

  The generated eventId.

method captureSession

captureSession: (endSession: boolean) => void;

• Sends the current session on the scope to Sentry

  Parameter endSession

  If set the session will be marked as exited and removed from the scope

method configureScope

configureScope: (callback: (scope: Scope) => void) => void;

• Callback to set context information onto the scope.

  Parameter callback

  Callback function that receives Scope.

method endSession

endSession: () => void;

• Ends the session that lives on the current scope and sends it to Sentry

method getClient

getClient: () => Client | undefined;

• Returns the client of the top stack.

method getIntegration

getIntegration: <T extends Integration>(
    integration: IntegrationClass<T>
) => T | null;

• Returns the integration if installed on the current client.

method isOlderThan

isOlderThan: (version: number) => boolean;

• Checks if this hub's version is older than the given version.

  Parameter version

  A version number to compare to. True if the given version is newer; otherwise false.

method lastEventId

lastEventId: () => string | undefined;

• This is the getter for lastEventId.

  Returns

  The last event id of a captured event.

method popScope

popScope: () => boolean;

• Removes a previously pushed scope from the stack.

  This restores the state before the scope was pushed. All breadcrumbs and context information added since the last call to this.pushScope are discarded.

method pushScope

pushScope: () => Scope;

• Create a new scope to store context information.

  The scope will be layered on top of the current one. It is isolated, i.e. all breadcrumbs and context information added to this scope will be removed once the scope ends. Be sure to always remove this scope with this.popScope when the operation finishes or throws.

  Returns

  Scope, the new cloned scope

method run

run: (callback: (hub: Hub) => void) => void;

• For the duration of the callback, this hub will be set as the global current Hub. This function is useful if you want to run your own client and hook into an already initialized one e.g.: Reporting issues to your own sentry when running in your component while still using the users configuration.

method setContext

setContext: (name: string, context: { [key: string]: any }) => void;

• Sets context data with the given name.

  Parameter name

  of the context

  Parameter context

  Any kind of data. This data will be normalized.

method setExtra

setExtra: (key: string, extra: Extra) => void;

• Set key:value that will be sent as extra data with the event.

  Parameter key

  String of extra

  Parameter extra

  Any kind of data. This data will be normalized.

method setExtras

setExtras: (extras: Extras) => void;

• Set an object that will be merged sent as extra data with the event.

  Parameter extras

  Extras object to merge into current context.

method setTag

setTag: (key: string, value: Primitive) => void;

• Set key:value that will be sent as tags data with the event.

  Can also be used to unset a tag, by passing undefined.

  Parameter key

  String key of tag

  Parameter value

  Value of tag

method setTags

setTags: (tags: { [key: string]: Primitive }) => void;

• Set an object that will be merged sent as tags data with the event.

  Parameter tags

  Tags context object to merge into current context.

method setUser

setUser: (user: User | null) => void;

• Updates user context information for future events.

  Parameter user

  User context object to be set in the current context. Pass null to unset the user.

method startSession

startSession: (context?: SessionContext) => Session;

• Starts a new Session, sets on the current scope and returns it.

  To finish a session, it has to be passed directly to client.captureSession, which is done automatically when using hub.endSession() for the session currently stored on the scope.

  When there's already an existing session on the scope, it'll be automatically ended.

  Parameter context

  Optional properties of the new Session.

  Returns

  The session which was just started

method startSpan

startSpan: (context: SpanContext) => Span;

• Deprecated

  No longer does anything. Use use Transaction.startChild instead.

method startTransaction

startTransaction: (
    context: TransactionContext,
    customSamplingContext?: CustomSamplingContext
) => Transaction;

• Starts a new Transaction and returns it. This is the entry point to manual tracing instrumentation.

  A tree structure can be built by adding child spans to the transaction, and child spans to other spans. To start a new child span within the transaction or any span, call the respective .startChild() method.

  Every child span must be finished before the transaction is finished, otherwise the unfinished spans are discarded.

  The transaction must be finished with a call to its .finish() method, at which point the transaction with all its finished child spans will be sent to Sentry.

  Parameter context

  Properties of the new Transaction.

  Parameter customSamplingContext

  Information given to the transaction sampling function (along with context-dependent default values). See Options.tracesSampler.

  Returns

  The transaction which was just started

method traceHeaders

traceHeaders: () => { [key: string]: string };

• Returns all trace headers that are currently on the top scope.

method withScope

withScope: (callback: (scope: Scope) => void) => void;

• Creates a new scope with and executes the given operation within. The scope is automatically removed once the operation finishes or throws.

  This is essentially a convenience function for:

  pushScope(); callback(); popScope();

  Parameter callback

  that will be enclosed into push/popScope.

property name

name: string;

• Returns IntegrationClass.id

method setupOnce

setupOnce: (
    addGlobalEventProcessor: (callback: EventProcessor) => void,
    getCurrentHub: () => Hub
) => void;

• Sets the integration up only once. This takes no options on purpose, options should be passed in the constructor

property id

id: string;

• Property that holds the integration name

construct signature

new (...args: any[]): T;

property data

data?: {
    [key: string]: string | boolean;
};

property handled

handled: boolean;

property synthetic

synthetic?: boolean;

property type

type: string;

property attachStacktrace

attachStacktrace?: boolean;

• Attaches stacktraces to pure capture message / log integrations

property autoSessionTracking

autoSessionTracking?: boolean;

• A flag enabling Sessions Tracking feature. By default, Sessions Tracking is enabled.

property debug

debug?: boolean;

• Enable debug functionality in the SDK itself

property defaultIntegrations

defaultIntegrations?: false | Integration[];

• If this is set to false, default integrations will not be added, otherwise this will internally be set to the recommended default integrations. TODO: We should consider changing this to boolean | Integration[]

property dist

dist?: string;

• Sets the distribution for all events

property dsn

dsn?: string;

• The Dsn used to connect to Sentry and identify the project. If omitted, the SDK will not send any data to Sentry.

property enabled

enabled?: boolean;

• Specifies whether this SDK should activate and send events to Sentry. Disabling the SDK reduces all overhead from instrumentation, collecting breadcrumbs and capturing events. Defaults to true.

property environment

environment?: string;

• The current environment of your application (e.g. "production").

property ignoreErrors

ignoreErrors?: Array<string | RegExp>;

• A pattern for error messages which should not be sent to Sentry. By default, all errors will be sent.

property initialScope

initialScope?: CaptureContext;

• Initial data to populate scope.

property integrations

integrations?: Integration[] | ((integrations: Integration[]) => Integration[]);

• List of integrations that should be installed after SDK was initialized. Accepts either a list of integrations or a function that receives default integrations and returns a new, updated list.

property logLevel

logLevel?: LogLevel;

• Console logging verbosity for the SDK Client.

property maxBreadcrumbs

maxBreadcrumbs?: number;

• The maximum number of breadcrumbs sent with events. Defaults to 100. Values over 100 will be ignored and 100 used instead.

property maxValueLength

maxValueLength?: number;

• Maxium number of chars a single value can have before it will be truncated.

property normalizeDepth

normalizeDepth?: number;

• Maximum number of levels that normalization algorithm will traverse in objects and arrays. Used when normalizing an event before sending, on all of the listed attributes: - breadcrumbs.data - user - contexts - extra Defaults to 3. Set to 0 to disable.

property release

release?: string;

• The release identifier used when uploading respective source maps. Specify this value to allow Sentry to resolve the correct source maps when processing events.

property sampleRate

sampleRate?: number;

• A global sample rate to apply to all events (0 - 1).

property shutdownTimeout

shutdownTimeout?: number;

• Controls how many milliseconds to wait before shutting down. The default is SDK-specific but typically around 2 seconds. Setting this too low can cause problems for sending events from command line applications. Setting it too high can cause the application to block for users with network connectivity problems.

property tracesSampleRate

tracesSampleRate?: number;

• Sample rate to determine trace sampling.

  0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send all traces)

  Tracing is enabled if either this or tracesSampler is defined. If both are defined, tracesSampleRate is ignored.

property transport

transport?: TransportClass<Transport>;

• Transport object that should be used to send events to Sentry

property transportOptions

transportOptions?: TransportOptions;

• Options for the default transport that the SDK uses.

property tunnel

tunnel?: string;

• A URL to an envelope tunnel endpoint. An envelope tunnel is an HTTP endpoint that accepts Sentry envelopes for forwarding. This can be used to force data through a custom server independent of the type of data.

method beforeBreadcrumb

beforeBreadcrumb: (
    breadcrumb: Breadcrumb,
    hint?: BreadcrumbHint
) => Breadcrumb | null;

• A callback invoked when adding a breadcrumb, allowing to optionally modify it before adding it to future events.

  Note that you must return a valid breadcrumb from this callback. If you do not wish to modify the breadcrumb, simply return it at the end. Returning null will cause the breadcrumb to be dropped.

  Parameter breadcrumb

  The breadcrumb as created by the SDK.

  Returns

  The breadcrumb that will be added | null.

method beforeSend

beforeSend: (
    event: Event,
    hint?: EventHint
) => PromiseLike<Event | null> | Event | null;

• A callback invoked during event submission, allowing to optionally modify the event before it is sent to Sentry.

  Note that you must return a valid event from this callback. If you do not wish to modify the event, simply return it at the end. Returning null will cause the event to be dropped.

  Parameter event

  The error or message event generated by the SDK.

  Parameter hint

  May contain additional information about the original exception.

  Returns

  A new event that will be sent | null.

method tracesSampler

tracesSampler: (samplingContext: SamplingContext) => number | boolean;

• Function to compute tracing sample rate dynamically and filter unwanted traces.

  Tracing is enabled if either this or tracesSampleRate is defined. If both are defined, tracesSampleRate is ignored.

  Will automatically be passed a context object of default and optional custom data. See Transaction.samplingContext and Hub.startTransaction.

  Returns

  A sample rate between 0 and 1 (0 drops the trace, 1 guarantees it will be sent). Returning true is equivalent to returning 1 and returning false is equivalent to returning 0.

property name

name: string;

property version

version: string;

property cookies

cookies?: {
    [key: string]: string;
};

property data

data?: any;

property env

env?: {
    [key: string]: string;
};

property headers

headers?: {
    [key: string]: string;
};

property method

method?: string;

property query_string

query_string?: QueryParams;

property url

url?: string;

property status

status?: RequestSessionStatus;

property event

event?: Event | Session;

property reason

reason?: string;

property status

status: Status;

property type

type?: EventType;

property name

name?: string;

property version

version?: string;

property location

location?: WorkerLocation;

• Object representing the URL of the current page or worker script. Passed by default when using the BrowserTracing integration.

property parentSampled

parentSampled?: boolean;

• Sampling decision from the parent transaction, if any.

property request

request?: ExtractedNodeRequestData;

• Object representing the incoming request to a node server. Passed by default when using the TracingHandler.

property transactionContext

transactionContext: TransactionContext;

• Context data with which transaction being sampled was created

method addBreadcrumb

addBreadcrumb: (breadcrumb: Breadcrumb, maxBreadcrumbs?: number) => this;

• Sets the breadcrumbs in the scope

  Parameter breadcrumbs

  Breadcrumb

  Parameter maxBreadcrumbs

  number of max breadcrumbs to merged into event.

method addEventProcessor

addEventProcessor: (callback: EventProcessor) => this;

• Add new event processor that will be called after applyToEvent.

method clear

clear: () => this;

• Clears the current scope and resets its properties.

method clearBreadcrumbs

clearBreadcrumbs: () => this;

• Clears all currently set Breadcrumbs.

method getRequestSession

getRequestSession: () => RequestSession | undefined;

• Returns the RequestSession if there is one

method getSession

getSession: () => Session | undefined;

• Returns the Session if there is one

method getSpan

getSpan: () => Span | undefined;

• Returns the Span if there is one

method getTransaction

getTransaction: () => Transaction | undefined;

• Returns the Transaction attached to the scope (if there is one)

method getUser

getUser: () => User | undefined;

• Returns the User if there is one

method setContext

setContext: (name: string, context: Context | null) => this;

• Sets context data with the given name.

  Parameter name

  of the context

  Parameter context

  an object containing context data. This data will be normalized. Pass null to unset the context.

method setExtra

setExtra: (key: string, extra: Extra) => this;

• Set key:value that will be sent as extra data with the event.

  Parameter key

  String of extra

  Parameter extra

  Any kind of data. This data will be normalized.

method setExtras

setExtras: (extras: Extras) => this;

• Set an object that will be merged sent as extra data with the event.

  Parameter extras

  Extras object to merge into current context.

method setFingerprint

setFingerprint: (fingerprint: string[]) => this;

• Sets the fingerprint on the scope to send with the events.

  Parameter fingerprint

  string[] to group events in Sentry.

method setLevel

setLevel: (level: Severity) => this;

• Sets the level on the scope for future events.

  Parameter level

  string Severity

method setRequestSession

setRequestSession: (requestSession?: RequestSession) => this;

• Sets the RequestSession on the scope

method setSession

setSession: (session?: Session) => this;

• Sets the Session on the scope

method setSpan

setSpan: (span?: Span) => this;

• Sets the Span on the scope.

  Parameter span

  Span

method setTag

setTag: (key: string, value: Primitive) => this;

• Set key:value that will be sent as tags data with the event.

  Can also be used to unset a tag by passing undefined.

  Parameter key

  String key of tag

  Parameter value

  Value of tag

method setTags

setTags: (tags: { [key: string]: Primitive }) => this;

• Set an object that will be merged sent as tags data with the event.

  Parameter tags

  Tags context object to merge into current context.

method setTransactionName

setTransactionName: (name?: string) => this;

• Sets the transaction name on the scope for future events.

method setUser

setUser: (user: User | null) => this;

• Updates user context information for future events.

  Parameter user

  User context object to be set in the current context. Pass null to unset the user.

method update

update: (captureContext?: CaptureContext) => this;

• Updates the scope with provided data. Can work in three variations: - plain object containing updatable attributes - Scope instance that'll extract the attributes from - callback function that'll receive the current scope as an argument and allow for modifications

  Parameter captureContext

  scope modifier to be used

property contexts

contexts: Contexts;

property extra

extra: Extras;

property fingerprint

fingerprint: string[];

property level

level: Severity;

property requestSession

requestSession: RequestSession;

property tags

tags: {
    [key: string]: Primitive;
};

property user

user: User;

property integrations

integrations?: string[];

property name

name?: string;

property packages

packages?: Package[];

property version

version?: string;

property sdk

sdk?: SdkInfo;

property body

body: string;

property type

type: SentryRequestType;

property url

url: string;

method close

close: (status?: SessionStatus) => void;

• JSDoc

method toJSON

toJSON: () => {
    init: boolean;
    sid: string;
    did?: string;
    timestamp: string;
    started: string;
    duration?: number;
    status: SessionStatus;
    errors: number;
    attrs?: {
        release?: string;
        environment?: string;
        user_agent?: string;
        ip_address?: string;
    };
};

• JSDoc

method update

update: (context?: SessionContext) => void;

• JSDoc

property aggregates

aggregates: Array<AggregationCounts>;

property attrs

attrs?: {
    environment?: string;
    release?: string;
};

property did

did?: string;

property duration

duration?: number;

property environment

environment?: string;

property errors

errors?: number;

property ignoreDuration

ignoreDuration?: boolean;

property init

init?: boolean;

property ipAddress

ipAddress?: string;

property release