File tree Expand file tree Collapse file tree 4 files changed +44
-14
lines changed Expand file tree Collapse file tree 4 files changed +44
-14
lines changed Original file line number Diff line number Diff line change @@ -26,7 +26,9 @@ import { SentryTransport } from 'winston-sentry-javascript-node';
2626const logger = winston .createLogger ({
2727 transports: [
2828 new SentryTransport ({
29- dsn: ' MY_SENTRY_DSN' ,
29+ sentry{
30+ dsn: ' MY_SENTRY_DSN' ,
31+ },
3032 }),
3133 ],
3234});
@@ -62,7 +64,9 @@ Catch and send `uncaughtException` to the Sentry.
6264const logger = winston .createLogger ({
6365 transports: [
6466 new SentryTransport ({
65- dsn: ' MY_SENTRY_DSN' ,
67+ sentry{
68+ dsn: ' MY_SENTRY_DSN' ,
69+ },
6670 handleExceptions: true ,
6771 }),
6872 ],
@@ -73,12 +77,37 @@ const logger = winston.createLogger({
7377const logger = winston .createLogger ({
7478 exceptionHandlers: [
7579 new SentryTransport ({
76- dsn: ' MY_SENTRY_DSN' ,
80+ sentry: {
81+ dsn: ' MY_SENTRY_DSN' ,
82+ }
7783 }),
7884 ]
7985});
8086```
8187
88+ ## Options
89+
90+ ``` javascript
91+ new SentryTransport (opts)
92+ ```
93+
94+ * opts: TransportStreamOptions
95+
96+ ``` javascript
97+ interface TransportStreamOptions {
98+ format?: logform .Format ;
99+ level?: string;
100+ silent?: boolean;
101+ handleExceptions?: boolean;
102+
103+ log? (info: any, next : () => void ): any;
104+ logv? (info: any, next : () => void ): any;
105+ close? (): void ;
106+ }
107+ ```
108+
109+ * opts.sentry: Please see [ Sentry client options] ( https://docs.sentry.io/error-reporting/configuration/?platform=javascript ) .
110+
82111## Default Extra for Error Object
83112
84113By default, if you provide an Error Object to logger, this package will set the following extra:
Original file line number Diff line number Diff line change @@ -5,7 +5,9 @@ import { SentryTransport } from '../src/index';
55const logger = winston . createLogger ( {
66 transports : [
77 new SentryTransport ( {
8- dsn : process . env . SENTRY_DSN ,
8+ sentry : {
9+ dsn : process . env . SENTRY_DSN ,
10+ } ,
911 level : 'error' ,
1012 handleExceptions : true ,
1113 } )
Original file line number Diff line number Diff line change 11{
22 "name" : " winston-sentry-javascript-node" ,
3- "version" : " 0.1.3 " ,
3+ "version" : " 0.2.0 " ,
44 "description" : " Sentry transport for the winson logger that using official Sentry SDK for javascript instead of the old Raven." ,
55 "main" : " lib/index.js" ,
66 "scripts" : {
Original file line number Diff line number Diff line change @@ -2,10 +2,6 @@ import { LogEntry } from 'winston';
22import Transport , { TransportStreamOptions } from 'winston-transport' ;
33import * as Sentry from '@sentry/node' ;
44
5- export interface SentryOption {
6- dsn : string ;
7- }
8-
95export interface Extra {
106 extra ?: {
117 [ key : string ] : any ;
@@ -22,14 +18,17 @@ export interface UserInfo {
2218 user ?: Sentry . User
2319}
2420
21+ export interface SentryOptions {
22+ sentry : Sentry . NodeOptions ;
23+ }
24+
2525export type Log = LogEntry & Extra & Tag & UserInfo ;
2626
2727export class SentryTransport extends Transport {
28- public constructor ( opts : TransportStreamOptions & SentryOption ) {
29- super ( opts ) ;
30- Sentry . init ( {
31- dsn : opts . dsn ,
32- } ) ;
28+ public constructor ( opts : TransportStreamOptions & SentryOptions ) {
29+ const { sentry, ...rest } = opts ;
30+ super ( rest ) ;
31+ Sentry . init ( sentry ) ;
3332 }
3433
3534 public log ( info : Log , next : ( ) => void ) : void {
You can’t perform that action at this time.
0 commit comments