@@ -23,13 +23,15 @@ var _ = io.WriteCloser(new(Writer))
2323
2424var now = time .Now
2525
26+ // Writer is a sentry events writer with std io.Writer iface.
2627type Writer struct {
2728 client * sentry.Client
2829
2930 levels map [zerolog.Level ]struct {}
3031 flushTimeout time.Duration
3132}
3233
34+ // Write handles zerolog's json and sends events to sentry.
3335func (w * Writer ) Write (data []byte ) (int , error ) {
3436 event , ok := w .parseLogEvent (data )
3537 if ok {
@@ -43,6 +45,8 @@ func (w *Writer) Write(data []byte) (int, error) {
4345 return len (data ), nil
4446}
4547
48+ // Close forces client to flush all pending events.
49+ // Can be useful before application exits.
4650func (w * Writer ) Close () error {
4751 w .client .Flush (w .flushTimeout )
4852 return nil
@@ -136,6 +140,7 @@ func bytesToStrUnsafe(data []byte) string {
136140 return * (* string )(unsafe .Pointer (& data ))
137141}
138142
143+ // WriterOption configures sentry events writer.
139144type WriterOption interface {
140145 apply (* config )
141146}
@@ -150,63 +155,77 @@ type config struct {
150155 release string
151156 environment string
152157 serverName string
158+ ignoreErrors []string
153159 debug bool
154160 flushTimeout time.Duration
155161}
156162
157- // WithLevels configures zerolog levels that have to be sent to Sentry. Default levels are error, fatal, panic
163+ // WithLevels configures zerolog levels that have to be sent to Sentry.
164+ // Default levels are: error, fatal, panic.
158165func WithLevels (levels ... zerolog.Level ) WriterOption {
159166 return optionFunc (func (cfg * config ) {
160167 cfg .levels = levels
161168 })
162169}
163170
164- // WithSampleRate configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0
171+ // WithSampleRate configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0.
165172func WithSampleRate (rate float64 ) WriterOption {
166173 return optionFunc (func (cfg * config ) {
167174 cfg .sampleRate = rate
168175 })
169176}
170177
178+ // WithRelease configures the release to be sent with events.
171179func WithRelease (release string ) WriterOption {
172180 return optionFunc (func (cfg * config ) {
173181 cfg .release = release
174182 })
175183}
176184
185+ // WithEnvironment configures the environment to be sent with events.
177186func WithEnvironment (environment string ) WriterOption {
178187 return optionFunc (func (cfg * config ) {
179188 cfg .environment = environment
180189 })
181190}
182191
183- // WithServerName configures the server name field for events. Default value is OS hostname
192+ // WithServerName configures the server name field for events. Default value is OS hostname.
184193func WithServerName (serverName string ) WriterOption {
185194 return optionFunc (func (cfg * config ) {
186195 cfg .serverName = serverName
187196 })
188197}
189198
190- // WithDebug enables sentry client debug logs
199+ // WithIgnoreErrors configures the list of regexp strings that will be used to match against event's message
200+ // and if applicable, caught errors type and value. If the match is found, then a whole event will be dropped.
201+ func WithIgnoreErrors (reList []string ) WriterOption {
202+ return optionFunc (func (cfg * config ) {
203+ cfg .ignoreErrors = reList
204+ })
205+ }
206+
207+ // WithDebug enables sentry client debug logs.
191208func WithDebug () WriterOption {
192209 return optionFunc (func (cfg * config ) {
193210 cfg .debug = true
194211 })
195212}
196213
214+ // New creates writer with provided DSN and options.
197215func New (dsn string , opts ... WriterOption ) (* Writer , error ) {
198216 cfg := newDefaultConfig ()
199217 for _ , opt := range opts {
200218 opt .apply (& cfg )
201219 }
202220
203221 client , err := sentry .NewClient (sentry.ClientOptions {
204- Dsn : dsn ,
205- SampleRate : cfg .sampleRate ,
206- Release : cfg .release ,
207- Environment : cfg .environment ,
208- ServerName : cfg .serverName ,
209- Debug : cfg .debug ,
222+ Dsn : dsn ,
223+ SampleRate : cfg .sampleRate ,
224+ Release : cfg .release ,
225+ Environment : cfg .environment ,
226+ ServerName : cfg .serverName ,
227+ IgnoreErrors : cfg .ignoreErrors ,
228+ Debug : cfg .debug ,
210229 })
211230
212231 if err != nil {
0 commit comments