Giter VIP home page Giter VIP logo

pino-sentry's Introduction

pino-sentry

CircleCI node license

Load pino logs into Sentry

Index

Install

npm install pino-sentry -g

Usage

CLI

node ./app.js | pino-sentry --dsn=https://******@sentry.io/12345

API

const { createWriteStream, Sentry } = require("pino-sentry");
// ...
const opts = {
  /* ... */
};
const stream = createWriteStream({ dsn: process.env.SENTRY_DSN });
const logger = pino(opts, stream);

// add tags
logger.info({ tags: { foo: "bar" }, msg: "Error" });

// add extra
logger.info({ extra: { foo: "bar" }, msg: "Error" });

// add breadcrumbs
// https://docs.sentry.io/platforms/node/enriching-events/breadcrumbs/
logger.info({
  msg: "Error",
  breadcrumbs: [
    {
      category: "auth",
      message: "Authenticated user " + user.email,
      level: "info",
    },
  ],
});

// the sentry instance is exposed and can be used to manipulate the same sentry than pino-sentry
Sentry.addBreadcrumb({
  category: "custom-logger",
  message: "Hey there!",
  level: "debug",
  type: "debug",
  data: { some: "data" },
});

Options (options)

Override Message Attributes

In case the generated message does not follow the standard convention, the main attribute keys can be mapped to different values, when the stream gets created. Following attribute keys can be overridden:

  • msg - the field used to get the message, it can be dot notted (eg 'data.msg')
  • extra
  • stack - the field used to get the stack, it can be dot notted (eg 'err.stack')
  • maxValueLength - option to adjust max string length for values, default is 250
  • decorateScope - option to decorate, manipulate the sentry scope just before the capture
  • sentryExceptionLevels - option that represent the levels that will be handled as exceptions. Default : error and fatal

const { createWriteStream, Sentry } = require("pino-sentry");
// ...
const opts = {
  /* ... */
};
const stream = createWriteStream({
  dsn: process.env.SENTRY_DSN,
  messageAttributeKey: "message",
  stackAttributeKey: "trace",
  extraAttributeKeys: ["req", "context"],
  maxValueLength: 250,
  sentryExceptionLevels: [
    Sentry.Severity.Warning,
    Sentry.Severity.Error,
    Sentry.Severity.Fatal,
  ],
  decorateScope: (data, scope) => {
    scope.setUser("userId", { id: data.userId });
  },
});
const logger = pino(opts, stream);

Transport options

  • --dsn (-d): your Sentry DSN or Data Source Name (defaults to process.env.SENTRY_DSN)
  • --environment (-e): (defaults to process.env.SENTRY_ENVIRONMENT || process.env.NODE_ENV || 'production')
  • --serverName (-n): transport name (defaults to pino-sentry)
  • --debug (-dm): turns debug mode on or off (default to process.env.SENTRY_DEBUG || false)
  • --sampleRate (-sr): sample rate as a percentage of events to be sent in the range of 0.0 to 1.0 (default to 1.0)
  • --maxBreadcrumbs (-mx): total amount of breadcrumbs that should be captured (default to 100)
  • --level (-l): minimum level for a log to be reported to Sentry (default to debug)

Log Level Mapping

Pino logging levels are mapped by default to Sentry's acceptable levels.

{
  trace: 'debug',
  debug: 'debug',
  info: 'info',
  warn: 'warning',
  error: 'error',
  fatal: 'fatal'
}

License

MIT License

pino-sentry's People

Contributors

aandrewww avatar glensc avatar gabemeola avatar jtassin avatar ginden avatar vojtech-cerveny avatar dependabot[bot] avatar abrkn avatar annieke avatar tplk avatar fredjens avatar koldunz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.