Sentry-javascript: Is it possible now? @sentry/node integration to wrap bunyan log calls as breadcrumbs SO link: https://stackoverflow.com/questions/53310580/sentry-node-integration-to-wrap-bunyan-log-calls-as-breadcrumbs

Created on 15 Nov 2018 · 3Comments · Source: getsentry/sentry-javascript

How can I make @sentry/node integration to wrap bunyan log calls as breadcrumbs ?

Package

@sentry/node 4.3.0

Description

Sentry by defaults has integration for console.log to make it part of breadcrumbs:

Link: Import name: Sentry.Integrations.Console

How can we make it to work for bunyan logger as well, like:

const koa = require('koa');
const app = new koa();
const bunyan = require('bunyan');
const log = bunyan.createLogger({
    name: 'app',
    ..... other settings go here ....
});
const Sentry = require('@sentry/node');
Sentry.init({
    dsn: MY_DSN_HERE,
    integrations: integrations => {
        // should anything be handled here & how?
        return [...integrations];
    },
    release: 'xxxx-xx-xx'
});

app.on('error', (err) => {
    Sentry.captureException(err);
});

// I am trying all to be part of sentry breadcrumbs 
// but only console.log('foo'); is working
console.log('foo');
log.info('bar');
log.warn('baz');
log.debug('any');
log.error('many');  

throw new Error('help!');

P.S. I have already tried bunyan-sentry-stream but no success with @sentry/node, it just pushes entries instead of treating them as breadcrumbs.

SO link: https://stackoverflow.com/questions/53310580/sentry-node-integration-to-wrap-bunyan-log-calls-as-breadcrumbs

Question

Source

zishon89us

Most helpful comment

https://docs.sentry.io/enriching-error-data/breadcrumbs/?platform=browser + as someone already answered on the SO:

var log = bunyan.createLogger({
  name: 'myapp',
  streams: [{
  level: 'debug',
  stream: {
    write: function(record) {
      Sentry.addBreadcrumb({
        message: record.msg,
        level: record.level
      });
    }
  }]
});

kamilogorek on 15 Nov 2018

👍2

All 3 comments

https://docs.sentry.io/enriching-error-data/breadcrumbs/?platform=browser + as someone already answered on the SO:

var log = bunyan.createLogger({
  name: 'myapp',
  streams: [{
  level: 'debug',
  stream: {
    write: function(record) {
      Sentry.addBreadcrumb({
        message: record.msg,
        level: record.level
      });
    }
  }]
});

kamilogorek on 15 Nov 2018

👍2

Original question was answered. Feel free to reopen if you still have more questions.

kamilogorek on 20 Nov 2018

If you are using typescript you might get some compiler issues for not providing a WriteableStream with the example above, therefore you can use the Writeable constructor as below.

Additionally:

the level emitted from Bunyan is a number, not a Senty severity, therefore you have to convert the value using level: Sentry.Severity.fromString(nameFromLevel[chunk.level])
I don't want to override the existing bunyan stream so use the addStream function instead of passing in BunyanOptions

// if you want some stronger typing around the bunyan log entry
interface BunyanChunk {
  pid?: number;
  level: number;
  msg: string
  // ...   hostname?: string;
  [custom: string]: unknown;
}

const appLogger = Bunyan.createLogger();

appLogger.addStream({
  level: 'debug',
  // use the Writable constructor and pass a write function
  stream: new Writable({
    write(c: string, encoding, next) {
      const chunk: BunyanChunk = JSON.parse(c);
      Sentry.addBreadcrumb({
        message: chunk.msg,
        // convert from a Bunyan level to a Sentry Severity
        level: Sentry.Severity.fromString(Bunyan.nameFromLevel[chunk.level]),
      });
      next();
    },
  }),
});