feat: Add Color Logging for Error Messages (#406)

* fix: fix this bug scripts * fix: set openim admin chat code
openimsdk · Feb 4, 2024 · a030b8a · a030b8a
1 parent 7886317
commit a030b8a
Show file tree

Hide file tree

Showing 15 changed files with 104 additions and 66 deletions.
diff --git a/.github/workflows/scripts-test.yml b/.github/workflows/scripts-test.yml
@@ -87,7 +87,7 @@ jobs:
         sudo make start
         sudo make check
 
-        sudo cat logs/openim_$(date '+%Y%m%d').log 2>/dev/null
+        sudo cat logs/chat_$(date '+%Y%m%d').log 2>/dev/null
         echo "pwd = $(pwd)"
         cd ..
         ls -al && pwd
@@ -127,7 +127,7 @@ jobs:
       run: |
         sudo make install
 
-    - name: Print openim_$(date '+%Y%m%d').log
+    - name: Print chat_$(date '+%Y%m%d').log
       run: |
         ls -al && echo "pwd = $(pwd)"
         sudo cat ./logs/* 2>/dev/null

diff --git a/Makefile b/Makefile
@@ -372,7 +372,7 @@ copyright-add: tools.verify.addlicense
 .PHONY: clean
 clean:
 	@echo "===========> Cleaning all builds TMP_DIR($(TMP_DIR)) AND BIN_DIR($(BIN_DIR))"
-	@-rm -vrf $(TMP_DIR) $(BIN_DIR)
+	@-rm -vrf $(TMP_DIR) $(BIN_DIR) _output/logs
 	@echo "===========> End clean..."
 
 ## help: Show this help info.

diff --git a/cmd/api/admin-api/main.go b/cmd/api/admin-api/main.go
@@ -16,12 +16,14 @@ package main
 
 import (
 	"fmt"
-	"github.com/OpenIMSDK/tools/errs"
 	"math/rand"
 	"net"
+	"os"
 	"strconv"
 	"time"
 
+	"github.com/OpenIMSDK/tools/errs"
+
 	"github.com/OpenIMSDK/chat/pkg/discovery_register"
 
 	"github.com/OpenIMSDK/chat/tools/component"
@@ -44,7 +46,8 @@ func main() {
 	rand.Seed(time.Now().UnixNano())
 	configFile, ginPort, showVersion, err := config.FlagParse()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 
 	// Check if the version flag was set
@@ -60,11 +63,13 @@ func main() {
 	}
 
 	if err := config.InitConfig(configFile); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	err = component.ComponentCheck()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if err := log.InitFromConfig("chat.log", "admin-api", *config.Config.Log.RemainLogLevel, *config.Config.Log.IsStdout, *config.Config.Log.IsJson, *config.Config.Log.StorageLocation, *config.Config.Log.RemainRotationCount, *config.Config.Log.RotationTime); err != nil {
 		panic(fmt.Errorf("InitFromConfig failed:%w", err))
@@ -77,7 +82,8 @@ func main() {
 	//zk, err = openKeeper.NewClient(config.Config.Zookeeper.ZkAddr, config.Config.Zookeeper.Schema,
 	//		openKeeper.WithFreq(time.Hour), openKeeper.WithUserNameAndPassword(config.Config.Zookeeper.Username, config.Config.Zookeeper.Password), openKeeper.WithRoundRobin(), openKeeper.WithTimeout(10), openKeeper.WithLogger(log.NewZkLogger()))
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 
 	if err := zk.CreateRpcRootNodes([]string{config.Config.RpcRegisterName.OpenImAdminName, config.Config.RpcRegisterName.OpenImChatName}); err != nil {
@@ -90,6 +96,7 @@ func main() {
 
 	address := net.JoinHostPort(config.Config.AdminApi.ListenIP, strconv.Itoa(ginPort))
 	if err := engine.Run(address); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 }
diff --git a/cmd/api/chat-api/main.go b/cmd/api/chat-api/main.go
@@ -17,12 +17,14 @@ package main
 import (
 	"flag"
 	"fmt"
-	"github.com/OpenIMSDK/tools/errs"
 	"math/rand"
 	"net"
+	"os"
 	"strconv"
 	"time"
 
+	"github.com/OpenIMSDK/tools/errs"
+
 	"github.com/OpenIMSDK/chat/pkg/discovery_register"
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 
@@ -51,7 +53,8 @@ func main() {
 
 	configFile, ginPort, showVersion, err := config.FlagParse()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 
 	// Check if the version flag was set
@@ -70,12 +73,13 @@ func main() {
 
 	err = config.InitConfig(configFile)
 	if err != nil {
-		fmt.Println("err ", err.Error())
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	err = component.ComponentCheck()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if err := log.InitFromConfig("chat.log", "chat-api", *config.Config.Log.RemainLogLevel, *config.Config.Log.IsStdout, *config.Config.Log.IsJson, *config.Config.Log.StorageLocation, *config.Config.Log.RemainRotationCount, *config.Config.Log.RotationTime); err != nil {
 		panic(fmt.Errorf("InitFromConfig failed:%w", err))
@@ -89,7 +93,8 @@ func main() {
 	openKeeper.WithFreq(time.Hour), openKeeper.WithUserNameAndPassword(config.Config.Zookeeper.Username,
 		config.Config.Zookeeper.Password), openKeeper.WithRoundRobin(), openKeeper.WithTimeout(10), openKeeper.WithLogger(log.NewZkLogger()))*/
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if err := zk.CreateRpcRootNodes([]string{config.Config.RpcRegisterName.OpenImAdminName, config.Config.RpcRegisterName.OpenImChatName}); err != nil {
 		panic(errs.Wrap(err, "CreateRpcRootNodes error"))
@@ -101,6 +106,7 @@ func main() {
 
 	address := net.JoinHostPort(config.Config.ChatApi.ListenIP, strconv.Itoa(ginPort))
 	if err := engine.Run(address); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 }
diff --git a/cmd/rpc/admin-rpc/main.go b/cmd/rpc/admin-rpc/main.go
@@ -18,6 +18,7 @@ import (
 	"flag"
 	"fmt"
 	"math/rand"
+	"os"
 	"time"
 
 	"github.com/OpenIMSDK/chat/pkg/common/chatrpcstart"
@@ -34,7 +35,8 @@ func main() {
 
 	configFile, rpcPort, showVersion, err := config.FlagParse()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 
 	// Check if the version flag was set
@@ -52,11 +54,13 @@ func main() {
 	flag.Parse()
 
 	if err := config.InitConfig(configFile); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	err = component.ComponentCheck()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if config.Config.Envs.Discovery == "k8s" {
 		rpcPort = 80
@@ -66,6 +70,7 @@ func main() {
 	}
 	err = chatrpcstart.Start(rpcPort, config.Config.RpcRegisterName.OpenImAdminName, 0, admin.Start)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 }
diff --git a/cmd/rpc/chat-rpc/main.go b/cmd/rpc/chat-rpc/main.go
@@ -17,6 +17,7 @@ package main
 import (
 	"fmt"
 	"math/rand"
+	"os"
 	"time"
 
 	"github.com/OpenIMSDK/chat/pkg/common/chatrpcstart"
@@ -32,7 +33,8 @@ func main() {
 	rand.Seed(time.Now().UnixNano())
 	configFile, rpcPort, showVersion, err := config.FlagParse()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 
 	// Check if the version flag was set
@@ -48,20 +50,23 @@ func main() {
 	}
 
 	if err := config.InitConfig(configFile); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if config.Config.Envs.Discovery == "k8s" {
 		rpcPort = 80
 	}
 	err = component.ComponentCheck()
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	if err := log.InitFromConfig("chat.log", "chat-rpc", *config.Config.Log.RemainLogLevel, *config.Config.Log.IsStdout, *config.Config.Log.IsJson, *config.Config.Log.StorageLocation, *config.Config.Log.RemainRotationCount, *config.Config.Log.RotationTime); err != nil {
 		panic(fmt.Errorf("InitFromConfig failed:%w", err))
 	}
 	err = chatrpcstart.Start(rpcPort, config.Config.RpcRegisterName.OpenImChatName, 0, chat.Start)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 }
diff --git a/internal/api/router.go b/internal/api/router.go
@@ -16,6 +16,9 @@ package api
 
 import (
 	"context"
+	"fmt"
+	"os"
+
 	"github.com/OpenIMSDK/chat/example/callback"
 
 	"github.com/OpenIMSDK/chat/pkg/common/config"
@@ -26,11 +29,13 @@ import (
 func NewChatRoute(router gin.IRouter, discov discoveryregistry.SvcDiscoveryRegistry) {
 	chatConn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImChatName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	adminConn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImAdminName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	mw := NewMW(adminConn)
 	chat := NewChat(chatConn, adminConn)
@@ -66,11 +71,13 @@ func NewChatRoute(router gin.IRouter, discov discoveryregistry.SvcDiscoveryRegis
 func NewAdminRoute(router gin.IRouter, discov discoveryregistry.SvcDiscoveryRegistry) {
 	adminConn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImAdminName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	chatConn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImChatName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	mw := NewMW(adminConn)
 	admin := NewAdmin(chatConn, adminConn)

diff --git a/pkg/email/mail_test.go b/pkg/email/mail_test.go
@@ -17,15 +17,19 @@ package email
 import (
 	"context"
 	"errors"
-	"github.com/OpenIMSDK/chat/pkg/common/config"
-	"gopkg.in/yaml.v3"
+	"fmt"
 	"io/ioutil"
+	"os"
 	"testing"
+
+	"github.com/OpenIMSDK/chat/pkg/common/config"
+	"gopkg.in/yaml.v3"
 )
 
 func TestEmail(T *testing.T) {
 	if err := InitConfig(); err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	tests := []struct {
 		name string

diff --git a/pkg/rpclient/chat/admin.go b/pkg/rpclient/chat/admin.go
@@ -16,6 +16,8 @@ package chat
 
 import (
 	"context"
+	"fmt"
+	"os"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 
@@ -28,7 +30,8 @@ import (
 func NewAdminClient(discov discoveryregistry.SvcDiscoveryRegistry) *AdminClient {
 	conn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImAdminName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	return &AdminClient{
 		client: admin.NewAdminClient(conn),

diff --git a/pkg/rpclient/chat/chat.go b/pkg/rpclient/chat/chat.go
@@ -16,6 +16,8 @@ package chat
 
 import (
 	"context"
+	"fmt"
+	"os"
 
 	"github.com/OpenIMSDK/tools/discoveryregistry"
 	"github.com/OpenIMSDK/tools/errs"
@@ -29,7 +31,8 @@ import (
 func NewChatClient(discov discoveryregistry.SvcDiscoveryRegistry) *ChatClient {
 	conn, err := discov.GetConn(context.Background(), config.Config.RpcRegisterName.OpenImChatName)
 	if err != nil {
-		panic(err)
+		fmt.Fprintf(os.Stderr, "\n\nexit -1: \n%+v\n\n", err)
+		os.Exit(-1)
 	}
 	return &ChatClient{
 		client: chat.NewChatClient(conn),

diff --git a/scripts/admin_rpc_start.sh b/scripts/admin_rpc_start.sh
@@ -42,7 +42,7 @@ sleep 1
 cd ${push_binary_root}
 
 for ((i = 0; i < ${#rpc_ports[@]}; i++)); do
-  nohup ./${push_name} -port ${rpc_ports[$i]} -prometheus_port ${prome_ports[$i]} >>../logs/openim_$(date '+%Y%m%d').log 2>&1 &
+  nohup ./${push_name} -port ${rpc_ports[$i]} -prometheus_port ${prome_ports[$i]} >>../logs/chat_$(date '+%Y%m%d').log 2>&1 &
 done
 
 sleep 3
@@ -61,5 +61,7 @@ if [ $check -ge 1 ]; then
   echo -e ${SKY_BLUE_PREFIX}"PID: "${COLOR_SUFFIX}${YELLOW_PREFIX}${newPid}${COLOR_SUFFIX}
   echo -e ${SKY_BLUE_PREFIX}"LISTENING_PORT: "${COLOR_SUFFIX}${YELLOW_PREFIX}${allPorts}${COLOR_SUFFIX}
 else
-  echo -e ${YELLOW_PREFIX}${push_name}${COLOR_SUFFIX}${RED_PREFIX}"SERVICE START ERROR, PLEASE CHECK openim_$(date '+%Y%m%d').log"${COLOR_SUFFIX}
+  echo -e ${YELLOW_PREFIX}${push_name}${COLOR_SUFFIX}${RED_PREFIX}"SERVICE START ERROR, PLEASE CHECK chat_$(date '+%Y%m%d').log"${COLOR_SUFFIX}
 fi
+
+echo -e ${SKY_BLUE_PREFIX}"# Start Chat push_rpc.sh "$(date +%H:%M:%S)" For local deployments, use ./push_rpc.sh --print-screen"${COLOR_SUFFIX}
diff --git a/scripts/build_all_service.sh b/scripts/build_all_service.sh
@@ -27,17 +27,9 @@ source $SCRIPTS_ROOT/style_info.sh
 source $SCRIPTS_ROOT/path_info.sh
 source $SCRIPTS_ROOT/function.sh
 
-echo -e "${YELLOW_PREFIX}=======>SCRIPTS_ROOT=$SCRIPTS_ROOT${COLOR_SUFFIX}"
-echo -e "${YELLOW_PREFIX}=======>OPENIM_ROOT=$OPENIM_ROOT${COLOR_SUFFIX}"
-echo -e "${YELLOW_PREFIX}=======>pwd=$PWD${COLOR_SUFFIX}"
-
-echo -e  ""
-
 echo -e "${BACKGROUND_BLUE}===============> Building all using make build binary files ${COLOR_SUFFIX}" 
 
 echo -e  ""
-echo -e "${BOLD_PREFIX}____________________________________________________________ ${COLOR_SUFFIX}"
-
 
 bin_dir="$BIN_DIR"
 logs_dir="$OPENIM_ROOT/_output/logs"