RequestData
Adds data about an incoming request to an event. (default)
This integration only works inside server environments (Node.js, Bun, Deno).
Upcoming Changes in v11
In version 11, the default behavior of the RequestData integration will likely change to be more privacy-conscious. Fields like cookies, data, headers, query_string, and user will default to false instead of true. To continue capturing this data after upgrading to v11, you'll need to either explicitly configure the RequestData Integration or set sendDefaultPii: true.
Import name: Sentry.requestDataIntegration
This integration is enabled by default. If you'd like to modify your default integrations, read this.
This integration adds data from incoming requests to transaction and error events that occur during request handling.
import * as Sentry from "@sentry/node";
Sentry.init({
dsn: "___PUBLIC_DSN___",
integrations: [Sentry.requestDataIntegration()],
});
By passing an include option, you can define what data from a request you want to capture:
requestDataIntegration({
// Controls what types of data are added to the event
include: {
cookies: boolean // default: true,
data: boolean // default: true,
headers: boolean // default: true,
ip: boolean // default: false,
query_string: boolean // default: true,
url: boolean // default: true,
user: boolean | {
id: boolean // default: true,
username: boolean // default: true,
email: boolean // default: true,
},
},
// Controls how the transaction will be reported. Options are 'path' (`/some/route`),
// 'methodPath' (`GET /some/route`), and 'handler' (the name of the route handler
// function, if available)
transactionNamingScheme: string // default: 'methodPath',
})
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").