feat: level log by replacing stl log with logrus

bruce2233 · bruce2233 · commit 225f0aec32ed · 2023-02-14T16:29:44.000+08:00
diff --git a/evnet.go b/evnet.go
@@ -1,22 +1,22 @@
 package evnet
 
 import (
-	"log"
+	log "github.com/sirupsen/logrus"
+
 	"os"
 	"strings"
 )
 
-func Run(eventHandler EventHandler, protoAddr string, optList ...Option) {
+func Run(eventHandler EventHandler, protoAddr string, optList ...SetOption) {
 	opts := loadOptions(optList)
 	if opts.LogPath != "" {
 		outputFile, err := os.OpenFile(opts.LogPath, os.O_CREATE|os.O_RDWR|os.O_APPEND, 0777)
 		if err != nil {
-			log.Println("log file open error")
+			log.Error("log file open error")
 		}
 		log.SetOutput(outputFile)
 	}
-	log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
-	log.Println("log test")
+	// log.SetFlags(log.Llongfile | log.Lmicroseconds | log.Ldate)
 	//options working
 	network, address := parseProtoAddr(protoAddr)
 
diff --git a/evnet_handler.go b/evnet_handler.go
@@ -2,7 +2,8 @@ package evnet
 
 import (
 	"errors"
-	"log"
+
+	log "github.com/sirupsen/logrus"
 )
 
 type EventHandler interface {
@@ -26,31 +27,31 @@ type BuiltinEventHandler struct {
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnConn(c Conn) error {
-	log.Println("OnConn triggered ", c.Fd())
+	log.Info("OnConn triggered ", c.Fd())
 	return nil
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnClose(c Conn) error {
-	log.Println("OnClose triggered ", c.Fd())
+	log.Info("OnClose triggered ", c.Fd())
 	return nil
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnTraffic(c Conn) error {
-	log.Println("OnClose triggered ", c.Fd())
+	log.Debug("OnClose triggered ", c.Fd())
 	return nil
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnOpen(c Conn) error {
-	log.Fatalln("OnOpen triggered ", c.Fd())
+	log.Info("OnOpen triggered ", c.Fd())
 	return nil
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnShutdown(mr *MainReactor) error {
-	log.Fatalln("OnShutdown triggered ")
+	log.Info("OnShutdown triggered ")
 	return nil
 }
 
 func (builtinEventHandler BuiltinEventHandler) OnBoot(mr *MainReactor) error {
-	log.Fatalln("OnBoot triggered ")
+	log.Info("OnBoot triggered ")
 	return nil
 }
diff --git a/evnet_test.go b/evnet_test.go
@@ -2,12 +2,13 @@ package evnet
 
 import (
 	"errors"
-	"log"
 	"math/rand"
 	"net"
 	"reflect"
 	"testing"
 
+	log "github.com/sirupsen/logrus"
+
 	. "github.com/bruce2233/evnet/socket"
 
 	"golang.org/x/sys/unix"
@@ -25,15 +26,15 @@ type MyHandler struct {
 	BuiltinEventHandler
 }
 
-func (mh MyHandler) OnTraffic(c Conn) error{
+func (mh MyHandler) OnTraffic(c Conn) error {
 	p, _ := c.Next(-1)
 	c.Write(p)
-	log.Println("receive", len(p))
+	log.Debug("receive", len(p))
 	return nil
 }
 
-func (mh MyHandler) OnClose(c Conn) error{
-	log.Println("On Close Trigger")
+func (mh MyHandler) OnClose(c Conn) error {
+	log.Debug("On Close Trigger")
 	return nil
 }
 func TestMainRec(t *testing.T) {
diff --git a/go.mod b/go.mod
@@ -4,6 +4,7 @@ go 1.18
 
 require (
 	github.com/evanphx/wildcat v0.0.0-20141114174135-e7012f664567
+	github.com/sirupsen/logrus v1.9.0
 	github.com/zyedidia/generic v1.2.1
 	golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664
 )
diff --git a/go.sum b/go.sum
@@ -5,13 +5,16 @@ github.com/evanphx/wildcat v0.0.0-20141114174135-e7012f664567 h1:7+oQw6YjB/kk9x2
 github.com/evanphx/wildcat v0.0.0-20141114174135-e7012f664567/go.mod h1:XNGflD53X+hfdCAt1NGeBUgiUpe9QmweW/zI1gV26Zw=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sirupsen/logrus v1.9.0 h1:trlNQbNUG3OdDrDil03MCb1H2o9nJ1x4/5LYw7byDE0=
+github.com/sirupsen/logrus v1.9.0/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/vektra/errors v0.0.0-20140903201135-c64d83aba85a h1:lUVfiMMY/te9icPKBqOKkBIMZNxSpM90dxokDeCcfBg=
 github.com/vektra/errors v0.0.0-20140903201135-c64d83aba85a/go.mod h1:KUxJS71XlMs+ztT+RzsLRoWUQRUpECo/+Rb0EBk8/Wc=
 github.com/zyedidia/generic v1.2.1 h1:Zv5KS/N2m0XZZiuLS82qheRG4X1o5gsWreGb0hR7XDc=
 github.com/zyedidia/generic v1.2.1/go.mod h1:ly2RBz4mnz1yeuVbQA/VFwGjK3mnHGRj1JuoG336Bis=
+golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664 h1:v1W7bwXHsnLLloWYTVEdvGvA7BHMeBYsPcF0GLDxIRs=
 golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
diff --git a/http_test.go b/http_test.go
@@ -1,12 +1,12 @@
 package evnet
 
 import (
-	"log"
 	"net/http"
 	"testing"
 	"time"
 
 	"github.com/evanphx/wildcat"
+	log "github.com/sirupsen/logrus"
 )
 
 type HttpServer struct {
@@ -19,8 +19,8 @@ type httpCodec struct {
 }
 
 func (hs *HttpServer) OnBoot(mr *MainReactor) error {
-	log.Println("\n=================Welcome!=================")
-	log.Println("\n███████╗██╗░░░██╗███╗░░██╗███████╗████████╗\n██╔════╝██║░░░██║████╗░██║██╔════╝╚══██╔══╝\n█████╗░░╚██╗░██╔╝██╔██╗██║█████╗░░░░░██║░░░\n██╔══╝░░░╚████╔╝░██║╚████║██╔══╝░░░░░██║░░░\n███████╗░░╚██╔╝░░██║░╚███║███████╗░░░██║░░░\n╚══════╝░░░╚═╝░░░╚═╝░░╚══╝╚══════╝░░░╚═╝░░░")
+	log.Info("\n=================Welcome!=================")
+	log.Info("\n███████╗██╗░░░██╗███╗░░██╗███████╗████████╗\n██╔════╝██║░░░██║████╗░██║██╔════╝╚══██╔══╝\n█████╗░░╚██╗░██╔╝██╔██╗██║█████╗░░░░░██║░░░\n██╔══╝░░░╚████╔╝░██║╚████║██╔══╝░░░░░██║░░░\n███████╗░░╚██╔╝░░██║░╚███║███████╗░░░██║░░░\n╚══════╝░░░╚═╝░░░╚═╝░░╚══╝╚══════╝░░░╚═╝░░░")
 	return nil
 }
 
diff --git a/reactor.go b/reactor.go
@@ -15,13 +15,14 @@ package evnet
 
 import (
 	"errors"
-	"log"
 	"math/rand"
 	"net"
 	"os"
 	"runtime"
 	"sync"
 
+	log "github.com/sirupsen/logrus"
+
 	. "github.com/bruce2233/evnet/socket"
 
 	"golang.org/x/sys/unix"
@@ -91,7 +92,7 @@ func (mr *MainReactor) Init(proto, addr string) error {
 		return err
 	}
 	mr.poller = p
-	log.Println("debug:  init main poller: ", p)
+	log.Debug("init main poller: ", p)
 
 	//init subReactor
 	for i := 0; i < SubReactorsNum; i++ {
@@ -111,7 +112,7 @@ func (mr *MainReactor) Init(proto, addr string) error {
 	listenerFd, _, err := TcpSocket(proto, addr, true)
 	mr.listener.Fd = listenerFd
 	if err != nil {
-		log.Println("error:  ", err)
+		log.Error("error:  ", err)
 	}
 
 	//add listenerFd epoll
@@ -156,22 +157,22 @@ func setEventHandler(mr *MainReactor, eh EventHandler) {
 
 func (mainReactor *MainReactor) Loop() {
 
-	log.Println("debug: ", "mainReactor create", "poller: ", mainReactor.poller, "linstenerFd is ", mainReactor.listener.Fd)
+	log.Debug("mainReactor create", "poller: ", mainReactor.poller, "linstenerFd is ", mainReactor.listener.Fd)
 
 	for {
-		log.Println("debug: ", "main reactor start polling")
+		log.Debug("main reactor start polling")
 		eventsList := mainReactor.poller.Polling()
 		//working
 		for _, v := range eventsList {
 			nfd, raddr, err := AcceptSocket(int(v.Fd))
-			// log.Println("debug: ", nfd, raddr.Network(), raddr.String())
+			// log.Debug(nfd, raddr.Network(), raddr.String())
 			os.NewSyscallError("AcceptSocket Err", err)
 			//convert from nfd, tcpAddr to a socket
 			// err = mainReactor.subReactors[0].poller.AddPollRead(int(v.Fd))
 			idx := rand.Intn(2)
 			laddr := mainReactor.listener.addr
 			c, _ := NewConn(nfd, laddr, raddr)
-			log.Println("debug: ", "mainReactor accept connection ", raddr, "to subReactor ", idx)
+			log.Debug("mainReactor accept connection ", raddr, "to subReactor ", idx)
 			sr := mainReactor.subReactors[idx]
 			registerConn(sr, c)
 		}
@@ -197,13 +198,13 @@ func (mr *MainReactor) stop() {
 
 func (sr *SubReactor) Loop() error {
 	for {
-		log.Println("debug: ", "SubReactor start polling", sr.poller.Fd)
+		log.Debug("SubReactor start polling", sr.poller.Fd)
 		eventList := sr.poller.Polling()
 		for _, event := range eventList {
-			log.Println("debug: ", "events: ", event.Events)
+			log.Debug("events: ", event.Events)
 			if event.Events&OutEvents != 0 {
 				c := sr.connections[int(event.Fd)]
-				log.Println("debug: ", "subReactor OutEvents from: ", c.RemoteAddr())
+				log.Debug("subReactor OutEvents from: ", c.RemoteAddr())
 				sr.write(c)
 			}
 
@@ -243,7 +244,7 @@ func polling(epfd int) []unix.EpollEvent {
 	var err error
 	for {
 		n, err = unix.EpollWait(epfd, eventsList, -1)
-		log.Println("debug:  ", "epoll trigger")
+		log.Debug("epoll trigger")
 		// if return EINTR, EpollWait again
 		// debugging will trigger unix.EINTR error
 		if n < 0 && err == unix.EINTR {
@@ -260,14 +261,14 @@ func polling(epfd int) []unix.EpollEvent {
 
 func (sr *SubReactor) read(c *conn) error {
 	n, err := unix.Read(c.Fd(), sr.buffer)
-	log.Println("debug: ", "sr read n:", n)
+	log.Debug("sr read n:", n)
 	// log.Println("sr.buffer len():", len(sr.buffer))
 	if n == 0 {
 		sr.closeConn(c)
 	}
 	if err != nil {
 		if err == unix.EAGAIN {
-			log.Println("err: ", unix.EAGAIN)
+			log.Warn(unix.EAGAIN)
 			return unix.EAGAIN
 		}
 		return unix.ECONNRESET
@@ -276,13 +277,13 @@ func (sr *SubReactor) read(c *conn) error {
 	err = (**sr.eventHandlerPP).OnTraffic(c)
 	if err != nil {
 		if err == ErrClose {
-			log.Println("debug:  ErrClose")
+			log.Info(ErrClose)
 			sr.closeConn(c)
 		}
-		if err.Error() == "Shutdown" {
-			log.Println("debug:  ErrShutdonw")
-			return err
+		if err == ErrShutdown {
+			log.Info(ErrShutdown)
 		}
+		return err
 	}
 	return nil
 }
@@ -294,8 +295,13 @@ func (sr *SubReactor) write(c *conn) error {
 
 	n, err := unix.Write(c.Fd(), c.outboundBuffer)
 	if err != nil {
-		log.Println("error: ", "subReactor Write error")
+		log.Warn("subReactor Write error")
+		if n == -1 {
+			log.Warn("subReactor try to write a closed conn")
+		}
+		sr.closeConn(c)
 	}
+
 	if n == buffedLen {
 		//the c.outbound data belongs to the peek of queue
 		cur := c.asyncTaskQueue.Dequeue()
@@ -360,7 +366,7 @@ func AcceptSocket(fd int) (int, net.Addr, error) {
 	case *unix.SockaddrInet4:
 		sa4, ok := sa.(*unix.SockaddrInet4)
 		if !ok {
-			log.Println("sa4 asset error")
+			log.Error("sa4 assertion error")
 		}
 		return nfd, &net.TCPAddr{IP: sa4.Addr[:], Port: sa4.Port}, err
 	}

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,8 @@ package evnet`
`2`	`2`
`3`	`3`	`import (`
`4`	`4`	`"errors"`
`5`		`- "log"`
	`5`	`+`
	`6`	`+ log "github.com/sirupsen/logrus"`
`6`	`7`	`)`
`7`	`8`
`8`	`9`	`type EventHandler interface {`
`@@ -26,31 +27,31 @@ type BuiltinEventHandler struct {`
`26`	`27`	`}`
`27`	`28`
`28`	`29`	`func (builtinEventHandler BuiltinEventHandler) OnConn(c Conn) error {`
`29`		`- log.Println("OnConn triggered ", c.Fd())`
	`30`	`+ log.Info("OnConn triggered ", c.Fd())`
`30`	`31`	`return nil`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`func (builtinEventHandler BuiltinEventHandler) OnClose(c Conn) error {`
`34`		`- log.Println("OnClose triggered ", c.Fd())`
	`35`	`+ log.Info("OnClose triggered ", c.Fd())`
`35`	`36`	`return nil`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`func (builtinEventHandler BuiltinEventHandler) OnTraffic(c Conn) error {`
`39`		`- log.Println("OnClose triggered ", c.Fd())`
	`40`	`+ log.Debug("OnClose triggered ", c.Fd())`
`40`	`41`	`return nil`
`41`	`42`	`}`
`42`	`43`
`43`	`44`	`func (builtinEventHandler BuiltinEventHandler) OnOpen(c Conn) error {`
`44`		`- log.Fatalln("OnOpen triggered ", c.Fd())`
	`45`	`+ log.Info("OnOpen triggered ", c.Fd())`
`45`	`46`	`return nil`
`46`	`47`	`}`
`47`	`48`
`48`	`49`	`func (builtinEventHandler BuiltinEventHandler) OnShutdown(mr *MainReactor) error {`
`49`		`- log.Fatalln("OnShutdown triggered ")`
	`50`	`+ log.Info("OnShutdown triggered ")`
`50`	`51`	`return nil`
`51`	`52`	`}`
`52`	`53`
`53`	`54`	`func (builtinEventHandler BuiltinEventHandler) OnBoot(mr *MainReactor) error {`
`54`		`- log.Fatalln("OnBoot triggered ")`
	`55`	`+ log.Info("OnBoot triggered ")`
`55`	`56`	`return nil`
`56`	`57`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@ go 1.18`
`4`	`4`
`5`	`5`	`require (`
`6`	`6`	`github.com/evanphx/wildcat v0.0.0-20141114174135-e7012f664567`
	`7`	`+ github.com/sirupsen/logrus v1.9.0`
`7`	`8`	`github.com/zyedidia/generic v1.2.1`
`8`	`9`	`golang.org/x/sys v0.0.0-20220808155132-1c4a2a72c664`
`9`	`10`	`)`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`package evnet`
`2`	`2`
`3`	`3`	`import (`
`4`		`- "log"`
`5`	`4`	`"net/http"`
`6`	`5`	`"testing"`
`7`	`6`	`"time"`
`8`	`7`
`9`	`8`	`"github.com/evanphx/wildcat"`
	`9`	`+ log "github.com/sirupsen/logrus"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`type HttpServer struct {`
`@@ -19,8 +19,8 @@ type httpCodec struct {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`func (hs HttpServer) OnBoot(mr MainReactor) error {`
`22`		`- log.Println("\n=================Welcome!=================")`
`23`		- log.Println("\n███████╗██╗░░░██╗███╗░░██╗███████╗████████╗\n██╔════╝██║░░░██║████╗░██║██╔════╝╚══██╔══╝\n█████╗░░╚██╗░██╔╝██╔██╗██║█████╗░░░░░██║░░░\n██╔══╝░░░╚████╔╝░██║╚████║██╔══╝░░░░░██║░░░\n███████╗░░╚██╔╝░░██║░╚███║███████╗░░░██║░░░\n╚══════╝░░░╚═╝░░░╚═╝░░╚══╝╚══════╝░░░╚═╝░░░")
	`22`	`+ log.Info("\n=================Welcome!=================")`
	`23`	+ log.Info("\n███████╗██╗░░░██╗███╗░░██╗███████╗████████╗\n██╔════╝██║░░░██║████╗░██║██╔════╝╚══██╔══╝\n█████╗░░╚██╗░██╔╝██╔██╗██║█████╗░░░░░██║░░░\n██╔══╝░░░╚████╔╝░██║╚████║██╔══╝░░░░░██║░░░\n███████╗░░╚██╔╝░░██║░╚███║███████╗░░░██║░░░\n╚══════╝░░░╚═╝░░░╚═╝░░╚══╝╚══════╝░░░╚═╝░░░")
`24`	`24`	`return nil`
`25`	`25`	`}`
`26`	`26`