Namespace: Handlers
sentry.Handlers
Type Aliases
ExpressRequest
Ƭ ExpressRequest: PolymorphicRequest
Deprecated
Handlers.ExpressRequest is deprecated and will be removed in v8. Use PolymorphicRequest instead.
ParseRequestOptions
Ƭ ParseRequestOptions: AddRequestDataToEventOptions["include"] & { serverName?: boolean ; version?: boolean }
Options deciding what parts of the request to use when enhancing an event
Deprecated
Handlers.ParseRequestOptions is deprecated and will be removed in v8. Use
AddRequestDataToEventOptions in @sentry/utils instead.
RequestHandlerOptions
Ƭ RequestHandlerOptions: ParseRequestOptions | AddRequestDataToEventOptions & { flushTimeout?: number }
Functions
errorHandler
▸ errorHandler(options?): (error: MiddlewareError, req: http.IncomingMessage, res: http.ServerResponse, next: (error: MiddlewareError) => void) => void
Express compatible error handler.
Parameters
| Name | Type |
|---|---|
options? |
Object |
options.shouldHandleError? |
(this: void, error: MiddlewareError) => boolean |
Returns
fn
▸ (error, req, res, next): void
Parameters
| Name | Type |
|---|---|
error |
MiddlewareError |
req |
http.IncomingMessage |
res |
http.ServerResponse |
next |
(error: MiddlewareError) => void |
Returns
void
See
Exposed as Handlers.errorHandler
extractRequestData
▸ extractRequestData(req, keys?): ExtractedNodeRequestData
Normalizes data from the request object, accounting for framework differences.
Parameters
| Name | Type | Description |
|---|---|---|
req |
Object |
The request object from which to extract data |
keys? |
string[] |
An optional array of keys to include in the normalized data. |
Returns
ExtractedNodeRequestData
An object containing normalized request data
Deprecated
Handlers.extractRequestData is deprecated and will be removed in v8. Use extractRequestData instead.
requestHandler
▸ requestHandler(options?): (req: http.IncomingMessage, res: http.ServerResponse, next: (error?: any) => void) => void
Express compatible request handler.
Parameters
| Name | Type |
|---|---|
options? |
RequestHandlerOptions |
Returns
fn
▸ (req, res, next): void
Parameters
| Name | Type |
|---|---|
req |
http.IncomingMessage |
res |
http.ServerResponse |
next |
(error?: any) => void |
Returns
void
See
Exposed as Handlers.requestHandler
tracingHandler
▸ tracingHandler(): (req: http.IncomingMessage, res: http.ServerResponse, next: (error?: any) => void) => void
Express-compatible tracing handler.
Returns
fn
▸ (req, res, next): void
Parameters
| Name | Type |
|---|---|
req |
http.IncomingMessage |
res |
http.ServerResponse |
next |
(error?: any) => void |
Returns
void
See
Exposed as Handlers.tracingHandler
trpcMiddleware
▸ trpcMiddleware(options?): <T>({ path, type, next, rawInput }: TrpcMiddlewareArguments<T>) => T
Sentry tRPC middleware that names the handling transaction after the called procedure.
Use the Sentry tRPC middleware in combination with the Sentry server integration, e.g. Express Request Handlers or Next.js SDK.
Parameters
| Name | Type |
|---|---|
options? |
SentryTrpcMiddlewareOptions |
Returns
fn
▸ <T>({ path, type, next, rawInput }): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
{ path, type, next, rawInput } |
TrpcMiddlewareArguments<T> |
Returns
T
Deprecated
Please use the top level export instead:
// OLD
import * as Sentry from '@sentry/node';
Sentry.Handlers.trpcMiddleware();
// NEW
import * as Sentry from '@sentry/node';
Sentry.trpcMiddleware();