Connect
Add @sentry/node
as a dependency:
Copied
npm install --save @sentry/node
Configure Sentry as a middleware:
Copied
import connect from "connect";
import * as Sentry from "@sentry/node";
// or using CommonJS
// const connect = require('connect');
// const Sentry = require('@sentry/node');
// Must configure Sentry before doing anything else with it
Sentry.init({ dsn: "https://examplePublicKey@o0.ingest.sentry.io/0" });
function mainHandler(req, res) {
throw new Error("My first Sentry error!");
}
function onError(err, req, res, next) {
// The error id is attached to `res.sentry` to be returned
// and optionally displayed to the user for support.
res.statusCode = 500;
res.end(res.sentry + "\n");
}
connect(
// The request handler must be the first item
Sentry.Handlers.requestHandler(),
connect.bodyParser(),
connect.cookieParser(),
mainHandler,
// The error handler must be before any other error middleware
Sentry.Handlers.errorHandler(),
// Optional fallthrough error handler
onError
).listen(3000);
requestHandler
accepts some options that let you control its behavior and decide what data should be included in the event sent to Sentry.
Possible options are:
Copied
// keys to be extracted from the request
request?: boolean | string[]; // default: true = ['cookies', 'data', 'headers', 'method', 'query_string', 'url']
// include server name in the event data?
serverName?: boolean; // default: true
// pattern for transaction name
// path == request.path (eg. "/foo")
// methodPath == request.method + request.path (eg. "GET|/foo")
// handler == function name (eg. "fooHandler")
transaction?: boolean | 'path' | 'methodPath' | 'handler'; // default: true = 'methodPath'
// keys to be extracted from req.user
user?: boolean | string[]; // default: true = ['id', 'username', 'email']
// include client ip address in the event data?
ip?: boolean; // default: false
// include node version in the event data?
version?: boolean; // default: true
// timeout for fatal route errors to be delivered
flushTimeout?: number; // default: 2000
For example, if you want to skip the server name and add just user, you would use requestHandler
like this:
Copied
app.use(
Sentry.Handlers.requestHandler({
serverName: false,
user: ["email"],
})
);
By default, errorHandler
will capture only errors with a status code of 500
or higher. If you want to change it, provide it with the shouldHandleError
callback, which accepts a middleware error as its argument, decides whether an event should be sent to Sentry or not, and returns the appropriate boolean value.
Copied
app.use(
Sentry.Handlers.errorHandler({
shouldHandleError(error) {
// Capture all 404 and 500 errors
if (error.status === 404 || error.status === 500) {
return true;
}
return false;
},
})
);
Help improve this content
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").
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").