A Sentry Transport for Winston@3
A Sentry transport for Wiston@3 using @sentry/node that allows logging context data, such as user, tags, fingerprint, and extra data. Learn more checking the Sentry Documentation.
Installation
# npm npm install sentry-transport-winston # yarn yarn add sentry-transport-winston
Initializing
; ; ; ;
Transport Options
The SentryTransportOpts
interface is extending the TransportStreamOptions
so you can pass any options that are handled by the base winston transport stream, such as format
. Take a look here to see all the available options.
Sentry Options
The SentryTransportOpts
includes the property sentryOpts
which is passed directly to the Sentry.init()
method, without any changes. All available options can be found on Sentry documentation.
Levels Mapping
SentryTransport
is using the npm logging levels by default (just like winston does) and mapping them to Sentry logging levels:
;
If you're using different logging levels, you can pass a custom map using the levelsMap
option.
Logging
Simple message
logger.info'Error message.';
Error message
logger.errornew Error'Error message';
Tags
You can tag an event using the tags
property:
; logger.error'Error message.', ;
User
You can capture the user using the user
property:
; logger.error'Error message.', ;
The user object must have at least one of the following properties: id
, email
, username
or ip_address
. Otherwise it will be logged as extra data.
Fingerprint
You can set a fingerprint using the fingerprint
property.
; logger.error'Error message.', ;
If the fingerprint
is not an array it will be converted to one.
; // it'll be converted to ['my-fingerprint']; logger.error'Error message.', ;
Extra data
Any other data which is not named as tags
, user
or fingerprint
will be logged as extra data.
logger.error'Error message.', ;
License
This project is MIT Licensed.