refactor: rename MultiHandler to FanoutHandler

Author: samber

README.md

@@ -45,7 +45,7 @@ No breaking changes will be made to exported APIs before v1.0.0.
 
 GoDoc: [https://pkg.go.dev/github.com/samber/slog-multi](https://pkg.go.dev/github.com/samber/slog-multi)
 
-### Fanout: `slogmulti.Multi()`
+### Broadcast: `slogmulti.Fanout()`
 
 Distribute logs to multiple `slog.Handler` in parallel.
 
@@ -60,9 +60,9 @@ func main() {
     stderr := os.Stderr
 
     logger := slog.New(
-        slogmulti.NewMultiHandler(
-            slog.HandlerOptions{}.NewJSONHandler(logstash),  // first handler: logstash over tcp
-            slog.HandlerOptions{}.NewTextHandler(stderr),    // second handler: stderr
+        slogmulti.Fanout(
+            slog.HandlerOptions{}.NewJSONHandler(logstash),  // pass to first handler: logstash over tcp
+            slog.HandlerOptions{}.NewTextHandler(stderr),    // then to second handler: stderr
             // ...
         ),
     )
@@ -248,12 +248,14 @@ import (
     "golang.org/x/exp/slog"
 )
 
+
 func main() {
 	// ncat -l 1000 -k
 	// ncat -l 1001 -k
 	// ncat -l 1002 -k
 
     // list AZs
+    // use github.com/netbrain/goautosocket for auto-reconnect
 	logstash1, _ := net.Dial("tcp", "logstash.eu-west-3a.internal:1000")
 	logstash2, _ := net.Dial("tcp", "logstash.eu-west-3b.internal:1000")
 	logstash3, _ := net.Dial("tcp", "logstash.eu-west-3c.internal:1000")

examples/either/example.go

@@ -14,10 +14,6 @@ func main() {
 	// ncat -l 1001 -k
 	// ncat -l 1002 -k
 
-	// logstash1, err := gas.Dial("tcp", "logstash.eu-west-3a.internal:1000")
-	// logstash2, err := gas.Dial("tcp", "logstash.eu-west-3b.internal:1000")
-	// logstash3, err := gas.Dial("tcp", "logstash.eu-west-3c.internal:1000")
-
 	logstash1, _ := net.Dial("tcp", "localhost:1000")
 	logstash2, _ := net.Dial("tcp", "localhost:1001")
 	logstash3, _ := net.Dial("tcp", "localhost:1002")

examples/multi/example.go renamed to examples/fanout/example.go

@@ -31,7 +31,7 @@ func main() {
 	stderr := os.Stderr
 
 	logger := slog.New(
-		slogmulti.NewMultiHandler(
+		slogmulti.Fanout(
 			slog.HandlerOptions{}.NewJSONHandler(logstash),
 			slog.HandlerOptions{}.NewTextHandler(stderr),
 		),

multi.go

@@ -7,17 +7,17 @@ import (
 	"golang.org/x/exp/slog"
 )
 
-type MultiHandler struct {
+type FanoutHandler struct {
 	handlers []slog.Handler
 }
 
-func NewMultiHandler(handlers ...slog.Handler) slog.Handler {
-	return &MultiHandler{
+func Fanout(handlers ...slog.Handler) slog.Handler {
+	return &FanoutHandler{
 		handlers: handlers,
 	}
 }
 
-func (h *MultiHandler) Enabled(ctx context.Context, l slog.Level) bool {
+func (h *FanoutHandler) Enabled(ctx context.Context, l slog.Level) bool {
 	for i := range h.handlers {
 		if h.handlers[i].Enabled(ctx, l) {
 			return true
@@ -28,7 +28,7 @@ func (h *MultiHandler) Enabled(ctx context.Context, l slog.Level) bool {
 }
 
 // @TODO: return multiple errors ?
-func (h *MultiHandler) Handle(ctx context.Context, r slog.Record) error {
+func (h *FanoutHandler) Handle(ctx context.Context, r slog.Record) error {
 	for i := range h.handlers {
 		if h.handlers[i].Enabled(ctx, r.Level) {
 			err := try(func() error {
@@ -43,16 +43,16 @@ func (h *MultiHandler) Handle(ctx context.Context, r slog.Record) error {
 	return nil
 }
 
-func (h *MultiHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
+func (h *FanoutHandler) WithAttrs(attrs []slog.Attr) slog.Handler {
 	handers := lo.Map(h.handlers, func(h slog.Handler, _ int) slog.Handler {
 		return h.WithAttrs(attrs)
 	})
-	return NewMultiHandler(handers...)
+	return Fanout(handers...)
 }
 
-func (h *MultiHandler) WithGroup(name string) slog.Handler {
+func (h *FanoutHandler) WithGroup(name string) slog.Handler {
 	handers := lo.Map(h.handlers, func(h slog.Handler, _ int) slog.Handler {
 		return h.WithGroup(name)
 	})
-	return NewMultiHandler(handers...)
+	return Fanout(handers...)
 }