Pino Sentry transport

[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![bundle][bundle-src]][bundle-href]
[![JSDocs][jsdocs-src]][jsdocs-href]
[![License][license-src]][license-href]

[//]: # ([](https://github.com/tomer-yechiel/pino-sentry-transport/actions))

Pino Sentry Transport allows you to send logs from Pino directly to Sentry.

Installation

``shell
npm i pino-sentry-transport
`

Usage

`typescript
import pino from "pino";

const logger = pino({
transport: {
target: "pino-sentry-transport",
options: {
sentry: {
dsn: "https://:@sentry.io/",
// additional options for Sentry
},
// default false - send the entire log record to Sentry as a context.
// FYI: if it's more than 8Kb, Sentry will throw an error
withLogRecord: true,
// sentry tags to add to the event, uses lodash.get to get the value from the log record
tags: ['level'],
// sentry context to add to the event, uses lodash.get to get the value from the log record
context: ['hostname'],
// which level to send to Sentry
minLevel: 40,
// default false - pass true if pino is configured with custom messageKey or errorKey, see below
expectPinoConfig: true,
}
},
});
`




$3

- withLogRecord: When set to true, sends the entire log record as context to Sentry. Be cautious of log records larger than 8KB, as Sentry will throw an error.
- tags: An array specifying which fields from the log record should be added as tags in Sentry. Uses lodash.get to extract values.
- context: An array specifying which fields from the log record should be added as context in Sentry. Also uses lodash.get for value extraction.
- minLevel: The minimum log level required for a message to be sent to Sentry. Log levels follow Pino's conventions (e.g., 50 for 'error').
- expectPinoConfig: If set to true, allows the transport to work with custom messageKey or errorKey` settings in Pino.

$3

Because Pino transport runs in a separate worker thread, Sentry needs to be initialized in the transport.

$3

This project is licensed under the MIT License - see the LICENSE file for details.

[npm-version-src]: https://img.shields.io/npm/v/pino-sentry-transport
[npm-version-href]: https://npmjs.com/package/pino-sentry-transport
[npm-downloads-src]: https://img.shields.io/npm/dm/pino-sentry-transport
[npm-downloads-href]: https://npmjs.com/package/pino-sentry-transport
[bundle-src]: https://img.shields.io/bundlephobia/minzip/pino-sentry-transport?label=minzip
[bundle-href]: https://bundlephobia.com/result?p=pino-sentry-transport
[license-src]: https://img.shields.io/github/license/tomer-yechiel/pino-sentry-transport.svg
[license-href]: https://github.com/tomer-yechiel/pino-sentry-transport/blob/main/LICENSE
[jsdocs-src]: https://img.shields.io/badge/jsdocs-reference-080f12
[jsdocs-href]: https://www.jsdocs.io/package/pino-sentry-transport