a
/
zlog
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Diode module Documentation update (#71) 

* Updated Diode example to match new style

* DOC: changed w to wr in assigment to reduce ambiguity
This commit is contained in:
Rafael Passos 2018-05-25 18:45:33 -03:00 committed by Olivier Poitrey
parent 77db4b4f35
commit c19f1e5eed
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -298,10 +298,9 @@ log.Logger = log.With().Str("foo", "bar").Logger()
If your writer might be slow or not thread-safe and you need your log producers to never get slowed down by a slow writer, you can use a `diode.Writer` as follow: If your writer might be slow or not thread-safe and you need your log producers to never get slowed down by a slow writer, you can use a `diode.Writer` as follow:
```go ```go
d := diodes.NewManyToOne(1000, diodes.AlertFunc(func(missed int) { wr := diode.NewWriter(os.Stdout, 1000, 10*time.Millisecond, func(missed int) {
fmt.Printf("Dropped %d messages\n", missed) fmt.Printf("Logger Dropped %d messages", missed)
})) })
w := diode.NewWriter(os.Stdout, d, 10*time.Millisecond)
log := zerolog.New(w) log := zerolog.New(w)
log.Print("test") log.Print("test")
``` ```

5
diode/diode.go
View File

@ -35,10 +35,11 @@ type Writer struct {
// //
// Use a diode.Writer when // Use a diode.Writer when
// //
// w := diode.NewWriter(w, 1000, 10 * time.Millisecond, func(missed int) { // wr := diode.NewWriter(w, 1000, 10 * time.Millisecond, func(missed int) {
// log.Printf("Dropped %d messages", missed) // log.Printf("Dropped %d messages", missed)
// }) // })
// log := zerolog.New(w) // log := zerolog.New(wr)
//
// //
// See code.cloudfoundry.org/go-diodes for more info on diode. // See code.cloudfoundry.org/go-diodes for more info on diode.
func NewWriter(w io.Writer, size int, poolInterval time.Duration, f Alerter) Writer { func NewWriter(w io.Writer, size int, poolInterval time.Duration, f Alerter) Writer {