ps

pino-sentry

🚥 Load pino logs into Sentry

Showing:

Popularity

Downloads/wk

4.1K

GitHub Stars

28

Maintenance

Last Commit

5mos ago

Contributors

9

Package

Dependencies

5

Size (min+gzip)

42.3KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

No?

Categories

Readme

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 } = 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" });

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
  • extra
  • stack
  • maxValueLength - option to adjust max string length for values, default is 250
const { createWriteStream } = require('pino-sentry');
// ...
const opts = { /* ... */ };
const stream = createWriteStream({
  dsn: process.env.SENTRY_DSN,
  messageAttributeKey: 'message',
  stackAttributeKey: 'trace',
  extraAttributeKeys: ['req', 'context'],
  maxValueLength: 250,
});
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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100