Google Cloud Functions - Sentry Client Set Up

[vpontis]

Hi team, love Sentry, thank you!

I'm using Google Cloud Functions w/ Typescript for a new project and I'd love to use Sentry to capture errors.

From this comment, it looks like Cloud Functions doesn't let 3rd parties hook into Node's global error handler.

Is that still accurate? Can I get Sentry JS library working with Google Cloud Functions?

Related: https://forum.sentry.io/t/google-cloud-functions-client-setup/1970

[kamilogorek]

Hey, thanks! :)

Is that still accurate? Can I get Sentry JS library working with Google Cloud Functions?

According to https://github.com/googleapis/nodejs-error-reporting#catching-and-reporting-application-wide-uncaught-errors and https://github.com/googleapis/nodejs-error-reporting#unhandled-rejections it's possible to do so now, however, I haven't tested it myself yet.

I can do so in a few days, but you can give it a spin if you have some spare time :)

[vpontis]

Thanks @kamilogorek. Interesting!

I'm not sure how that interacts w/ Google Cloud Functions. I'm in the middle of technical planning now so won't get to testing that soon. But I'll let you know if / when I do. :)

[vpontis]

Right now we are just wrapping all of our Cloud Functions in:

try () {
...
} catch (e) {
  Sentry.captureException(e);
}

But we aren't seeing the source code or other context in Sentry.

Is there a better way of doing this integration?

[kamilogorek]

@vpontis just tested it myself and context resolution seems to work just fine. What's your function/config?

[vpontis]

Hi @kamilogorek thanks for helping!

I have replicated what you get with Hello World, so that's great.

But there are no context variables. Like you can't see the value of the variables in scope? Or is that only a Python feature?

---

Also, it looks like the more complicated errors I am getting are when I am making writes / reads to the database and there is some error on a stream / event.

For example, in the screenshot below, I can't even tell what function it was called from.

What is your recommendation? Is there a way of getting a longer StackTrace that includes the call from the originating function handler? Or do I just need to add more breadcrumbs?

---

Also, any idea what's going on with these Source Code not found errors?

[kamilogorek]

But there are no context variables. Like you can't see the value of the variables in scope? Or is that only a Python feature?

It's Python only feature. JS doesn't provide a mechanism to implement this feature, unfortunately.

For example, in the screenshot below, I can't even tell what function it was called from. What is your recommendation? Is there a way of getting a longer StackTrace that includes the call from the originating function handler? Or do I just need to add more breadcrumbs?

There's no way to tell what called this specific function, as it was triggered by a socket. And as you mentioned, the best way to track this is to use breadcrumbs when you perform db queries, proxy calls or external service requests.

And because serverless instances are long-lived, you can call:

Sentry.configureScope(scope => scope.clear())
// or
Sentry.configureScope(scope => scope.clearBreadcrumbs())

to get a clean slate.

Also, any idea what's going on with these Source Code not found errors?

Turn off Enable JavaScript source fetching in your projects settings, eg. https://sentry.io/settings/kamil-ogorek/projects/testing-project/
It's serverless node app, so there's no point in doing that.

[vpontis]

It's Python only feature. JS doesn't provide a mechanism to implement this feature, unfortunately.

Damn. I loved this about Python!

Super helpful, thank you Kamil. I'll implement those changes and get back to you here if I have anymore questions. I'm sure this issue will be helpful to other people using Sentry on JS serverless.

[kamilogorek]

Awesome! I'll close the issue for triaging sake, but feel free to ping me anytime and I'll reopen it if necessary! :)

[vpontis]

@kamilogorek I added Breadcrumbs on Google Cloud Functions and I think I am seeing breadcrumbs from different function calls.

Does that make sense? How can I limit the breadcrumbs to be only from one HTTP request w/ Google Cloud Functions?

[kamilogorek]

It makes sense, however can you show me example code that you use in your cloud functions? This way it'd be easier to understand everything.

[vpontis]

@kamilogorek you've been really helpful!

We switched to using Koa with Docker / Node. So we have the Koa integration set up like this: https://docs.sentry.io/platforms/node/koa/

It's working pretty great except for breadcrumbs, we are seeing breadcrumbs for all requests on the server, not just breadcrumbs tied to the current request.

Is there a way to fix that?

[kamilogorek]

Is there a way to fix that?

There is, but I need to test it before providing the code here :)
I'll try to get back to you in ~1-2 days.

[vpontis]

@kamilogorek you are an absolute legend my friend

[kamilogorek]

@vpontis so the only thing you really need to do is to create a domain instance in one of your middlewares. Once it's there, SDK will detect it and use to separate the contexts. You can also move parseRequest to there as well. (example based on the https://github.com/koajs/examples/blob/master/errors/app.js )

const Sentry = require("@sentry/node");
const Koa = require("koa");
const app = (module.exports = new Koa());
const domain = require("domain");

Sentry.init({
  // ...
});

app.use(async function(ctx, next) {
  const local = domain.create();
  local.add(ctx);
  local.on("error", next);
  local.run(() => {
    Sentry.configureScope(scope => {
      scope.addEventProcessor(event => Sentry.Handlers.parseRequest(event, ctx.request));
    });
    next();
  });
});

app.use(async function(ctx, next) {
  try {
    await next();
  } catch (err) {
    // some errors will have .status
    // however this is not a guarantee
    ctx.status = err.status || 500;
    ctx.type = "html";
    ctx.body = "<p>Something <em>exploded</em>, please contact Maru.</p>";

    // since we handled this manually we'll
    // want to delegate to the regular app
    // level error handling as well so that
    // centralized still functions correctly.
    ctx.app.emit("error", err, ctx);
  }
});

// response

app.use(async function() {
  throw new Error("boom boom");
});

// error handler

app.on("error", function(err) {
  Sentry.captureException(err);
});

if (!module.parent) app.listen(3000);

parseRequest accepts some options that you may want to use to pick what request data you want to extract -

sentry-javascript/packages/node/src/handlers.ts

Line 177 in f71c174

export function parseRequest(