☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359)

* cicd: robot automated Change * feat: add api test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add api test make file Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add openim e2e test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add openim e2e test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: Fixed some unused scripts and some names Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * docs: optimize openim docs Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add prom address Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add openim info test * feat: add openim images config path Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * fix: fix tim file rename * fix: fix tim file rename * fix: fix tim file rename * fix: fix tim file rename * fix: add openim test e2e * feat: add openim test .keep Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: add openim test .keep Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: openim test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: openim test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> * feat: openim test Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> --------- Signed-off-by: Xinwei Xiong(cubxxw) <3293172751nss@gmail.com> Co-authored-by: cubxxw <cubxxw@users.noreply.github.com>
2026-05-11 20:45:57 +08:00 · 2023-11-10 19:37:25 +08:00
parent 686fa80800
commit e2004c1e9d
154 changed files with 4020 additions and 928 deletions
@@ -0,0 +1,16 @@
+package prommetrics
+
+import ginProm "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+
+/*
+labels := prometheus.Labels{"label_one": "any", "label_two": "value"}
+ApiCustomCnt.MetricCollector.(*prometheus.CounterVec).With(labels).Inc()
+*/
+var (
+	ApiCustomCnt = &ginProm.Metric{
+		Name:        "custom_total",
+		Description: "Custom counter events.",
+		Type:        "counter_vec",
+		Args:        []string{"label_one", "label_two"},
+	}
+)
@@ -0,0 +1,12 @@
+package prommetrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	UserLoginCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "user_login_total",
+		Help: "The number of user login",
+	})
+)
@@ -0,0 +1,24 @@
+package prommetrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	SingleChatMsgProcessSuccessCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "single_chat_msg_process_success_total",
+		Help: "The number of single chat msg successful processed",
+	})
+	SingleChatMsgProcessFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "single_chat_msg_process_failed_total",
+		Help: "The number of single chat msg failed processed",
+	})
+	GroupChatMsgProcessSuccessCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "group_chat_msg_process_success_total",
+		Help: "The number of group chat msg successful processed",
+	})
+	GroupChatMsgProcessFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "group_chat_msg_process_failed_total",
+		Help: "The number of group chat msg failed processed",
+	})
+)
@@ -0,0 +1,12 @@
+package prommetrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	OnlineUserGauge = prometheus.NewGauge(prometheus.GaugeOpts{
+		Name: "online_user_num",
+		Help: "The number of online user num",
+	})
+)
@@ -0,0 +1,12 @@
+package prommetrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	MsgOfflinePushFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "msg_offline_push_failed_total",
+		Help: "The number of msg failed offline pushed",
+	})
+)
@@ -0,0 +1,45 @@
+package prommetrics
+
+import (
+	grpc_prometheus "github.com/grpc-ecosystem/go-grpc-prometheus"
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/prometheus/client_golang/prometheus/collectors"
+)
+
+func NewGrpcPromObj(cusMetrics []prometheus.Collector) (*prometheus.Registry, *grpc_prometheus.ServerMetrics, error) {
+	////////////////////////////////////////////////////////
+	reg := prometheus.NewRegistry()
+	grpcMetrics := grpc_prometheus.NewServerMetrics()
+	grpcMetrics.EnableHandlingTimeHistogram()
+	cusMetrics = append(cusMetrics, grpcMetrics, collectors.NewGoCollector())
+	reg.MustRegister(cusMetrics...)
+	return reg, grpcMetrics, nil
+}
+
+func GetGrpcCusMetrics(registerName string) []prometheus.Collector {
+	switch registerName {
+	case config2.Config.RpcRegisterName.OpenImMessageGatewayName:
+		return []prometheus.Collector{OnlineUserGauge}
+	case config2.Config.RpcRegisterName.OpenImMsgName:
+		return []prometheus.Collector{SingleChatMsgProcessSuccessCounter, SingleChatMsgProcessFailedCounter, GroupChatMsgProcessSuccessCounter, GroupChatMsgProcessFailedCounter}
+	case "Transfer":
+		return []prometheus.Collector{MsgInsertRedisSuccessCounter, MsgInsertRedisFailedCounter, MsgInsertMongoSuccessCounter, MsgInsertMongoFailedCounter, SeqSetFailedCounter}
+	case config2.Config.RpcRegisterName.OpenImPushName:
+		return []prometheus.Collector{MsgOfflinePushFailedCounter}
+	case config2.Config.RpcRegisterName.OpenImAuthName:
+		return []prometheus.Collector{UserLoginCounter}
+	default:
+		return nil
+	}
+}
+
+func GetGinCusMetrics(name string) []*ginprometheus.Metric {
+	switch name {
+	case "Api":
+		return []*ginprometheus.Metric{ApiCustomCnt}
+	default:
+		return []*ginprometheus.Metric{ApiCustomCnt}
+	}
+}
@@ -0,0 +1,60 @@
+package prommetrics
+
+import (
+	"testing"
+
+	config2 "github.com/openimsdk/open-im-server/v3/pkg/common/config"
+	"github.com/prometheus/client_golang/prometheus"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestNewGrpcPromObj(t *testing.T) {
+	// Create a custom metric to pass into the NewGrpcPromObj function.
+	customMetric := prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "test_metric",
+		Help: "This is a test metric.",
+	})
+	cusMetrics := []prometheus.Collector{customMetric}
+
+	// Call NewGrpcPromObj with the custom metrics.
+	reg, grpcMetrics, err := NewGrpcPromObj(cusMetrics)
+
+	// Assert no error was returned.
+	assert.NoError(t, err)
+
+	// Assert the registry was correctly initialized.
+	assert.NotNil(t, reg)
+
+	// Assert the grpcMetrics was correctly initialized.
+	assert.NotNil(t, grpcMetrics)
+
+	// Assert that the custom metric is registered.
+	mfs, err := reg.Gather()
+	assert.NoError(t, err)
+	assert.NotEmpty(t, mfs) // Ensure some metrics are present.
+	found := false
+	for _, mf := range mfs {
+		if *mf.Name == "test_metric" {
+			found = true
+			break
+		}
+	}
+	assert.True(t, found, "Custom metric not found in registry")
+}
+
+func TestGetGrpcCusMetrics(t *testing.T) {
+	// Test various cases based on the switch statement in the GetGrpcCusMetrics function.
+	testCases := []struct {
+		name     string
+		expected int // The expected number of metrics for each case.
+	}{
+		{config2.Config.RpcRegisterName.OpenImMessageGatewayName, 1},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			metrics := GetGrpcCusMetrics(tc.name)
+			assert.Len(t, metrics, tc.expected)
+		})
+	}
+}
@@ -0,0 +1,28 @@
+package prommetrics
+
+import (
+	"github.com/prometheus/client_golang/prometheus"
+)
+
+var (
+	MsgInsertRedisSuccessCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "msg_insert_redis_success_total",
+		Help: "The number of successful insert msg to redis",
+	})
+	MsgInsertRedisFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "msg_insert_redis_failed_total",
+		Help: "The number of failed insert msg to redis",
+	})
+	MsgInsertMongoSuccessCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "msg_insert_mongo_success_total",
+		Help: "The number of successful insert msg to mongo",
+	})
+	MsgInsertMongoFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "msg_insert_mongo_failed_total",
+		Help: "The number of failed insert msg to mongo",
+	})
+	SeqSetFailedCounter = prometheus.NewCounter(prometheus.CounterOpts{
+		Name: "seq_set_failed_total",
+		Help: "The number of failed set seq",
+	})
+)