Skip to content

Commit 8f2199a

Browse files
authored
add logging section to readme (#853)
* add logging section to readme
1 parent fa5d62b commit 8f2199a

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -669,6 +669,45 @@ if err := r.Close(); err != nil {
669669
}
670670
```
671671

672+
673+
## Logging
674+
675+
For visiblity into the operations of the Reader/Writer types, configure a logger on creation.
676+
677+
678+
### Reader
679+
680+
```go
681+
func logf(msg string, a ...interface{}) {
682+
fmt.Println(msg, a...)
683+
}
684+
685+
r := kafka.NewReader(kafka.ReaderConfig{
686+
Brokers: []string{"localhost:9092"},
687+
Topic: "my-topic1",
688+
Partition: 0,
689+
Logger: kafka.LoggerFunc(logf),
690+
ErrorLogger: kafka.LoggerFunc(logf),
691+
})
692+
```
693+
694+
### Writer
695+
696+
```go
697+
func logf(msg string, a ...interface{}) {
698+
fmt.Println(msg, a...)
699+
}
700+
701+
w := &kafka.Writer{
702+
Addr: kafka.TCP("localhost:9092"),
703+
Topic: "topic",
704+
Logger: kafka.LoggerFunc(logf),
705+
ErrorLogger: kafka.LoggerFunc(logf),
706+
}
707+
```
708+
709+
710+
672711
## Testing
673712

674713
Subtle behavior changes in later Kafka versions have caused some historical tests to break, if you are running against Kafka 2.3.1 or later, exporting the `KAFKA_SKIP_NETTEST=1` environment variables will skip those tests.

0 commit comments

Comments
 (0)