How to install Sentry on the Back-end (NodeJS)

Wappler General How To
#8

For that to work you need to use something like browserify, grunt, webpack, etc

#9

We moved the sentry code into an external file to prevent Wappler to overwrite our custom code in server.js during an update of Wappler.

extensions/server_connect/routes/sentry.js:

// JavaScript Document

const Sentry = require('@sentry/node');
const Tracing = require("@sentry/tracing");

exports.handler = function (app) {
    Sentry.init({
        dsn: "CHANGE_ME",
        integrations: [
            // enable HTTP calls tracing
            new Sentry.Integrations.Http({tracing: true}),
            // enable Express.js middleware tracing
            new Tracing.Integrations.Express({app}),
        ],
        environment: process.env.MODE,
    });

    // RequestHandler creates a separate execution context using domains, so that every
    // transaction/span/breadcrumb is attached to its own Hub instance
    app.use(Sentry.Handlers.requestHandler());
    // TracingHandler creates a trace for every incoming request
    app.use(Sentry.Handlers.tracingHandler());

    app.use(Sentry.Handlers.errorHandler());
}
1 Like
#10

Maybe we should add some out of tge box integration to Sentry in Server Connect @patrick

5 Likes
#11
#12

@Eldynn Thanks - I’m just wondering if the app.use(Sentry.Handlers.errorHandler()); shouldn’t be put in here? image

After I’ve moved that line to the extension - it doesn’t seem to capture a 500 error.

I think that line needs to be run at the last route, which might not be possible in this way(?)

#13

How do you trigger your error?

If it doesn’t work then we need to revert and hook directly into server.js. Maybe the Wappler team will do the Sentry integration and it will fix this.

#14

Sentry should be initialized as early as possible.

#15

By loading a server connect that tries a DB update query that doesn’t work. It’s trying to update a record that doesn’t exist.

I’m quite sure it has to do by the fact that the code in /extensions is loaded too early for that error. Probably the same reason why the wappler devs load the error codes at the bottom of server.js

@JonL So in the server.js?

#16

Yup.

1 Like
#17

I think the way @Eldynn has it with the external file is the best way. The custom routes are loaded before the api routes, it is important that Sentry comes before other routes. Also the external file will never be updated by an Wappler update, so it is more future proof.

#18

@patrick It doesn’t catch all errors though this way. It did when it was set up like in this screenshot How to install Sentry on the Back-end (NodeJS)

(So I put the app.use(Sentry.Handlers.errorHandler()); where the arrow is pointing.)

So I think there needs to be a deeper integration

#19

I see, checked the documentation and the error handler should indeed be applied after all the routes, but before our error handler. Will see if we can maybe provide more hooks for you, so that you not need to edit our code.

4 Likes
Use npm at server level
#20

That would be amazing @patrick thanks!

#21

With the upcoming update you can have in your custom route next to exports.handler an exports.before and exports.after where the before is like the handler and comes before the generated routes and the after comes after all the routes are generated.

So code would become like:

const Sentry = require('@sentry/node');

exports.before = function(app) {
  Sentry.init({ dsn: "CHANGE_ME" });
  app.use(Sentry.Handlers.requestHandler());
};

exports.after = function(app) {
  app.use(Sentry.Handlers.errorHandler());
};

Save this to extensions/server_connect/routes/sentry.js.

6 Likes
How to instruct Node.js to handle a page intended for a different Application server
Simple server-cache solution
Forcing HTTPS on Heroku using NodeJS
#22

@patrick Thanks!!!

#23

Implemented in Wappler 3.9.5

#24
#25

Hello guys! How to get Sentry to track only production environment?

#26

@otavionestares You can use ENV variables or maybe even globals to get the environment. Something like this should do it:

const Sentry = require('@sentry/node');
const Tracing = require('@sentry/tracing');
require('dotenv').config();

if (process.env.MODE === 'production') {
  Sentry.init({
    dsn: process.env.SENTRY_DSN,
    integrations: [
      new Sentry.Integrations.Http({ tracing: true }),
      new Tracing.Integrations.Express({ app }),
    ],
    environment: process.env.MODE,
  });
}

exports.handler = function (app) {
  if (process.env.MODE === 'production') {
    app.use(Sentry.Handlers.requestHandler());
    app.use(Sentry.Handlers.tracingHandler());
    app.use(Sentry.Handlers.errorHandler());
  }
};
2 Likes
#27

This is awesome! :tada: :tada: :tada: So the only things you need to do to get Sentry working is?

  1. create a Sentry project, choose for express and obtain dsn
  2. npm install --save @sentry/node @sentry/tracing in your terminal
  3. create file extensions/server_connect/routes/sentry.js with Patrick’s contents

And this keeps sentry installed despite Wappler updates?