From da27adf6a27c9ac8c654d745b51ca83be11c3367 Mon Sep 17 00:00:00 2001 From: skiffer-git <44203734@qq.com> Date: Thu, 29 Jun 2023 17:03:23 +0800 Subject: [PATCH] Organize configuration files and configuration items, and remove redundant fields. --- config/config.yaml | 194 +++++++++++++-------------- internal/msggateway/init.go | 2 +- internal/tools/cron_task.go | 8 +- internal/tools/msg.go | 4 +- pkg/common/config/config.go | 34 +++-- pkg/common/db/controller/msg_test.go | 36 ++--- 6 files changed, 130 insertions(+), 148 deletions(-) diff --git a/config/config.yaml b/config/config.yaml index 7ee8265d0..3471196a9 100644 --- a/config/config.yaml +++ b/config/config.yaml @@ -1,93 +1,84 @@ -# OpenIM config +#OpenIM config #---------------Infrastructure configuration---------------------# zookeeper: - schema: openim #默认即可 + schema: openim #不建议修改 address: [ 127.0.0.1:2181 ] # - username: - password: + username: #用户名 + password: #密码 mysql: - address: [ 127.0.0.1:13306 ] #mysql地址 目前仅支持单机，默认即可 - username: root #mysql用户名，建议修改 - password: openIM123 # mysql密码，建议修改 - database: openIM_v2 #默认即可 - maxOpenConn: 100 # - maxIdleConn: 10 # - maxLifeTime: 5 # - logLevel: 4 # 1=slient 2=error 3=warn 4=info - slowThreshold: 500 # 毫秒 + address: [ 127.0.0.1:13306 ] #目前仅支持单机 + username: root #用户名 + password: openIM123 #密码 + database: openIM_v2 #不建议修改 + maxOpenConn: 1000 #最大连接数 + maxIdleConn: 100 #最大空闲连接数 + maxLifeTime: 60 #连接可以重复使用的最长时间（秒） + logLevel: 4 #日志级别 1=slient 2=error 3=warn 4=info + slowThreshold: 500 #慢语句阈值 （毫秒） mongo: uri: #不为空则直接使用该值 - address: [ 127.0.0.1:37017 ] #单机时为mongo地址，使用分片集群时，为mongos地址 默认即可 - timeout: 60 + address: [ 127.0.0.1:37017 ] #单机时为mongo地址，使用分片集群时，为mongos地址 database: openIM #mongo db 默认即可 - source: admin - username: root #mongo用户名，建议先不设置 - password: openIM123 #mongo密码，建议先不设置 + username: root #用户名 + password: openIM123 #密码 maxPoolSize: 100 - retainChatRecords: 3650 #mongo保存离线消息时间（天），根据需求修改 - chatRecordsClearTime: "0 2 * * 3" #每周三凌晨2点清除mongo中的过期消息，该配置和linux定时任务一样 redis: - address: [ 127.0.0.1:16379 ] #redis地址 单机时，填写一个地址即可，使用redis集群时候，填写集群中多个节点地址（主从地址都可以填写，增加容灾能力），默认即可 + address: [ 127.0.0.1:16379 ] # username: #only redis version 6.0+ need username - password: openIM123 #redis密码 建议修改 + password: openIM123 #密码 kafka: - username: - password: - addr: [ 127.0.0.1:9092 ] #kafka配置，默认即可 + username: #用户名 + password: #密码 + addr: [ 127.0.0.1:9092 ] # latestMsgToRedis: - topic: "latestMsgToRedis" # + topic: "latestMsgToRedis" #不建议修改 offlineMsgToMongo: - topic: "offlineMsgToMongoMysql" #用于mongo和mysql保存消息 + topic: "offlineMsgToMongoMysql" #不建议修改 msgToPush: - topic: "msqToPush" #消息push + topic: "msqToPush" #不建议修改 msgToModify: - topic: "msgToModify" #消息push - consumerGroupID: - msgToRedis: redis - msgToMongo: mongo - msgToMySql: mysql - msgToPush: push - msgToModify: modify - - -#---------------Internal service configuration---------------------# - - + topic: "msgToModify" #不建议修改 + consumerGroupID: #消费者组，不建议修改 + msgToRedis: redis # + msgToMongo: mongo # + msgToMySql: mysql # + msgToPush: push # + msgToModify: modify # rpc: registerIP: #作为rpc启动时，注册到zookeeper的IP，api/gateway能访问到此ip和对应的rpcPort中的端口 - listenIP: #如不设置则为 0.0.0.0 + listenIP: #默认为0.0.0.0 api: openImApiPort: [ 10002 ] #api服务端口 - listenIP: + listenIP: #默认为0.0.0.0 object: - enable: minio + enable: minio #使用minio apiURL: http://127.0.0.1:10002/third/object minio: - tempBucket: "openim" - dataBucket: "openim" - location: us-east-1 - endpoint: http://127.0.0.1:10005 #minio外网ip 这个ip是给客户端访问的 - accessKeyID: root - secretAccessKey: openIM123 - isDistributedMod: false #是否分布式多硬盘部署 默认docker-compose中为false，如果是多硬盘部署，需要修改为true - tencent: + tempBucket: "openim" #不建议修改 + dataBucket: "openim" #不建议修改 + location: us-east-1 #不建议修改 + endpoint: http://127.0.0.1:10005 #minio对外服务的ip和端口，app要能访问此ip和端口 + accessKeyID: root #ID + secretAccessKey: openIM123 #秘钥 + isDistributedMod: false #是否分布式多硬盘部署，如果是多硬盘部署，需要修改为true + tencent: #tencent cos appID: region: bucket: secretID: secretKey: - ali: # ali oss + ali: #ali oss regionID: accessKeyID: accessKeySecret: @@ -98,16 +89,16 @@ object: stsDurationSeconds: OssRoleArn: aws: - accessKeyID: #AssumeRole用户关联的accessKeyID - accessKeySecret: #AssumeRole用户关联的accessKeySecrect - region: #分区 - bucket: #桶 - finalHost: #对外Host - roleArn: #RoleArn - externalId: #角色扩展Id - roleSessionName: #角色SESSION名称 - -rpcPort: #rpc服务端口 默认即可 + accessKeyID: + accessKeySecret: + region: + bucket: + finalHost: + roleArn: + externalId: + roleSessionName: + +rpcPort: #rpc服务端口，不建议修改，端口由脚本读取后传入程序，如启动多个程序，只需要填入多个端口，用逗号隔开，如 openImUserPort: [10110, 10111] openImUserPort: [ 10110 ] openImFriendPort: [ 10120 ] openImMessagePort: [ 10130 ] @@ -119,7 +110,7 @@ rpcPort: #rpc服务端口 默认即可 openImRtcPort: [ 10190 ] openImThirdPort: [ 10200 ] -rpcRegisterName: #rpc注册服务名，默认即可 +rpcRegisterName: #rpc注册服务名，不建议修改 openImUserName: User openImFriendName: Friend openImMsgName: Msg @@ -128,71 +119,66 @@ rpcRegisterName: #rpc注册服务名，默认即可 openImGroupName: Group openImAuthName: Auth openImConversationName: Conversation - openImRtcName: Rtc openImThirdName: Third log: - storageLocation: ../logs/ - rotationTime: 24 - remainRotationCount: 2 #日志数量 - remainLogLevel: 6 #日志级别 6表示全都打印，测试阶段建议设置为6 + storageLocation: ../logs/ #存放目录 + rotationTime: 24 #日志旋转时间 + remainRotationCount: 2 #日志数量 + remainLogLevel: 6 #日志级别 6表示全都打印， isStdout: false isJson: false withStack: false - longConnSvr: - openImWsPort: [ 10001 ] #ws服务端口，默认即可，要开放此端口或做nginx转发 - websocketMaxConnNum: 10000 - websocketMaxMsgLen: 4096 - websocketTimeOut: 10 + openImWsPort: [ 10001 ] #msg_gateway的websocket端口 + websocketMaxConnNum: 100000 #websocket最大连接数 + websocketMaxMsgLen: 4096 #websocket请求包最大长度 + websocketTimeout: 10 #websocket连接握手超时时间 push: enable: getui - geTui: #个推推送 + geTui: #个推离线推送 pushUrl: "https://restapi.getui.com/v2/$appId" masterSecret: "" appKey: "" intent: "" channelID: "" channelName: "" - fcm: #firebase cloud message 消息推送 - serviceAccount: "openim-5c6c0-firebase-adminsdk-ppwol-8765884a78.json" #帐号文件，此处需要改修配置，并且这个文件放在 config目录下 - jpns: #极光推送 在极光后台申请后，修改以下四项，必须修改 + fcm: #fcm离线推送 + serviceAccount: "x.json" #帐号文件，并放在 config目录下 + jpns: #极光推送 在极光后台申请后，修改以下四项 appKey: masterSecret: pushUrl: pushIntent: - enable: false manager: - #app管理员userID和nickename， 用于管理后台登录 - userID: [ "openIM123456","openIM654321","openIMAdmin" ] - nickname: [ "system1","system2", "system3" ] + userID: [ "openIM123456","openIM654321","openIMAdmin" ] #内置的app管理员userID + nickname: [ "system1","system2", "system3" ] #内置的app管理员nickname + + +multiLoginPolicy: 1 #多平台登录：Android、iOS、Windows、Mac、web 每种平台只能有一个在线 + + +chatPersistenceMysql: true #消息是否存入mysql，mysql中的消息仅用于管理后台使用 +msgCacheTimeout: 86400 #信消息缓存时间秒，不建议修改 +groupMessageHasReadReceiptEnable: true #群聊已读是否开启 +singleMessageHasReadReceiptEnable: true #单聊已读是否开启 + +retainChatRecords: 365 #mongo保存离线消息时间（天） +chatRecordsClearTime: "0 2 * * 3" #每周三凌晨2点清理mongo中的过期（超过retainChatRecords时间）消息 -# 多端互踢策略 -# 1：多平台登录：Android、iOS、Windows、Mac 每种平台只能一个在线，web端可以多个同时在线 -multiLoginPolicy: 1 -#msg log insert to db -chatPersistenceMysql: true -#消息缓存时间 -msgCacheTimeout: 86400 -#群聊已读开启 -groupMessageHasReadReceiptEnable: true -#单聊已读开启 -singleMessageHasReadReceiptEnable: true -#token config tokenPolicy: - accessSecret: openIM123 #token生成相关，默认即可 - # Token effective time day as a unit - accessExpire: 90 #token过期时间（天） 默认即可 + accessSecret: openIM123 #秘钥，获取token时校验 + accessExpire: 90 #过期时间（天） messageVerify: - friendVerify: false + friendVerify: false #发送消息时是否验证好友关系 #ios系统推送声音以及标记计数 iosPush: @@ -201,12 +187,12 @@ iosPush: production: false callback: - # callback url 需要自行更换callback url + # 回调callback url: beforeSendSingleMsg: - enable: false # 回调是否启用 - timeout: 5 #callback超时时间（秒） - failedContinue: true #如果callback失败是否继续 + enable: false #是否启用此回调事件 + timeout: 5 #超时时间（秒） + failedContinue: true #如回调失败是否继续往后执行 afterSendSingleMsg: enable: false timeout: 5 @@ -263,8 +249,8 @@ callback: timeout: 5 failedContinue: true -# prometheus每个服务监听的端口数量需要和rpc port保持一致 -prometheus: + +prometheus: #prometheus每个服务的端口数量需要和rpcPort保持对应 enable: false userPrometheusPort: [ 20110 ] friendPrometheusPort: [ 20120 ] @@ -276,5 +262,5 @@ prometheus: conversationPrometheusPort: [ 20230 ] rtcPrometheusPort: [ 21300 ] thirdPrometheusPort: [ 21301 ] - messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] # 端口数量和 script/path_info.cfg msg_transfer_service_num保持一致 + messageTransferPrometheusPort: [ 21400, 21401, 21402, 21403 ] #端口数量需要和script/path_info.cfg中的msg_transfer_service_num保持一致 diff --git a/internal/msggateway/init.go b/internal/msggateway/init.go index 87f3c5464..2e001667a 100644 --- a/internal/msggateway/init.go +++ b/internal/msggateway/init.go @@ -12,7 +12,7 @@ func RunWsAndServer(rpcPort, wsPort, prometheusPort int) error { longServer, err := NewWsServer( WithPort(wsPort), WithMaxConnNum(int64(config.Config.LongConnSvr.WebsocketMaxConnNum)), - WithHandshakeTimeout(time.Duration(config.Config.LongConnSvr.WebsocketTimeOut)*time.Second), + WithHandshakeTimeout(time.Duration(config.Config.LongConnSvr.WebsocketTimeout)*time.Second), WithMessageMaxMsgLength(config.Config.LongConnSvr.WebsocketMaxMsgLen)) if err != nil { return err diff --git a/internal/tools/cron_task.go b/internal/tools/cron_task.go index c55a0d046..debf61a6d 100644 --- a/internal/tools/cron_task.go +++ b/internal/tools/cron_task.go @@ -11,8 +11,8 @@ import ( ) func StartCronTask() error { - log.ZInfo(context.Background(), "start cron task", "cron config", config.Config.Mongo.ChatRecordsClearTime) - fmt.Println("cron task start, config", config.Config.Mongo.ChatRecordsClearTime) + log.ZInfo(context.Background(), "start cron task", "cron config", config.Config.ChatRecordsClearTime) + fmt.Println("cron task start, config", config.Config.ChatRecordsClearTime) msgTool, err := InitMsgTool() if err != nil { return err @@ -20,9 +20,9 @@ func StartCronTask() error { c := cron.New() var wg sync.WaitGroup wg.Add(1) - _, err = c.AddFunc(config.Config.Mongo.ChatRecordsClearTime, msgTool.AllConversationClearMsgAndFixSeq) + _, err = c.AddFunc(config.Config.ChatRecordsClearTime, msgTool.AllConversationClearMsgAndFixSeq) if err != nil { - fmt.Println("start cron failed", err.Error(), config.Config.Mongo.ChatRecordsClearTime) + fmt.Println("start cron failed", err.Error(), config.Config.ChatRecordsClearTime) return err } c.Start() diff --git a/internal/tools/msg.go b/internal/tools/msg.go index f9fe100c5..fc810aa95 100644 --- a/internal/tools/msg.go +++ b/internal/tools/msg.go @@ -74,8 +74,8 @@ func (c *MsgTool) AllConversationClearMsgAndFixSeq() { func (c *MsgTool) ClearConversationsMsg(ctx context.Context, conversationIDs []string) { for _, conversationID := range conversationIDs { - if err := c.msgDatabase.DeleteConversationMsgsAndSetMinSeq(ctx, conversationID, int64(config.Config.Mongo.RetainChatRecords*24*60*60)); err != nil { - log.ZError(ctx, "DeleteUserSuperGroupMsgsAndSetMinSeq failed", err, "conversationID", conversationID, "DBRetainChatRecords", config.Config.Mongo.RetainChatRecords) + if err := c.msgDatabase.DeleteConversationMsgsAndSetMinSeq(ctx, conversationID, int64(config.Config.RetainChatRecords*24*60*60)); err != nil { + log.ZError(ctx, "DeleteUserSuperGroupMsgsAndSetMinSeq failed", err, "conversationID", conversationID, "DBRetainChatRecords", config.Config.RetainChatRecords) } if err := c.checkMaxSeq(ctx, conversationID); err != nil { log.ZError(ctx, "fixSeq failed", err, "conversationID", conversationID) diff --git a/pkg/common/config/config.go b/pkg/common/config/config.go index 6abba786d..3bccace36 100644 --- a/pkg/common/config/config.go +++ b/pkg/common/config/config.go @@ -53,16 +53,12 @@ type config struct { } `yaml:"mysql"` Mongo struct { - Uri string `yaml:"uri"` - Address []string `yaml:"address"` - Timeout int `yaml:"timeout"` - Database string `yaml:"database"` - Source string `yaml:"source"` - Username string `yaml:"username"` - Password string `yaml:"password"` - MaxPoolSize int `yaml:"maxPoolSize"` - RetainChatRecords int `yaml:"retainChatRecords"` - ChatRecordsClearTime string `yaml:"chatRecordsClearTime"` + Uri string `yaml:"uri"` + Address []string `yaml:"address"` + Database string `yaml:"database"` + Username string `yaml:"username"` + Password string `yaml:"password"` + MaxPoolSize int `yaml:"maxPoolSize"` } `yaml:"mongo"` Redis struct { @@ -170,7 +166,6 @@ type config struct { OpenImGroupName string `yaml:"openImGroupName"` OpenImAuthName string `yaml:"openImAuthName"` OpenImConversationName string `yaml:"openImConversationName"` - OpenImRtcName string `yaml:"openImRtcName"` OpenImThirdName string `yaml:"openImThirdName"` } `yaml:"rpcRegisterName"` @@ -188,7 +183,7 @@ type config struct { OpenImWsPort []int `yaml:"openImWsPort"` WebsocketMaxConnNum int `yaml:"websocketMaxConnNum"` WebsocketMaxMsgLen int `yaml:"websocketMaxMsgLen"` - WebsocketTimeOut int `yaml:"websocketTimeOut"` + WebsocketTimeout int `yaml:"websocketTimeout"` } `yaml:"longConnSvr"` Push struct { @@ -216,13 +211,14 @@ type config struct { Nickname []string `yaml:"nickname"` } `yaml:"manager"` - MultiLoginPolicy int `yaml:"multiLoginPolicy"` - ChatPersistenceMysql bool `yaml:"chatPersistenceMysql"` - MsgCacheTimeout int `yaml:"msgCacheTimeout"` - GroupMessageHasReadReceiptEnable bool `yaml:"groupMessageHasReadReceiptEnable"` - SingleMessageHasReadReceiptEnable bool `yaml:"singleMessageHasReadReceiptEnable"` - - TokenPolicy struct { + MultiLoginPolicy int `yaml:"multiLoginPolicy"` + ChatPersistenceMysql bool `yaml:"chatPersistenceMysql"` + MsgCacheTimeout int `yaml:"msgCacheTimeout"` + GroupMessageHasReadReceiptEnable bool `yaml:"groupMessageHasReadReceiptEnable"` + SingleMessageHasReadReceiptEnable bool `yaml:"singleMessageHasReadReceiptEnable"` + RetainChatRecords int `yaml:"retainChatRecords"` + ChatRecordsClearTime string `yaml:"chatRecordsClearTime"` + TokenPolicy struct { AccessSecret string `yaml:"accessSecret"` AccessExpire int64 `yaml:"accessExpire"` } `yaml:"tokenPolicy"` diff --git a/pkg/common/db/controller/msg_test.go b/pkg/common/db/controller/msg_test.go index 2ccefab19..e5bfe2e0d 100644 --- a/pkg/common/db/controller/msg_test.go +++ b/pkg/common/db/controller/msg_test.go @@ -18,15 +18,15 @@ import ( ) func Test_BatchInsertChat2DB(t *testing.T) { - config.Config.Mongo.DBAddress = []string{"192.168.44.128:37017"} - config.Config.Mongo.DBTimeout = 60 - config.Config.Mongo.DBDatabase = "openIM" - config.Config.Mongo.DBSource = "admin" - config.Config.Mongo.DBUserName = "root" - config.Config.Mongo.DBPassword = "openIM123" - config.Config.Mongo.DBMaxPoolSize = 100 - config.Config.Mongo.DBRetainChatRecords = 3650 - config.Config.Mongo.ChatRecordsClearTime = "0 2 * * 3" + config.Config.Mongo.Address = []string{"192.168.44.128:37017"} + config.Config.Mongo.Timeout = 60 + config.Config.Mongo.Database = "openIM" + config.Config.Mongo.Source = "admin" + config.Config.Mongo.Username = "root" + config.Config.Mongo.Password = "openIM123" + config.Config.Mongo.MaxPoolSize = 100 + config.Config.RetainChatRecords = 3650 + config.Config.ChatRecordsClearTime = "0 2 * * 3" mongo, err := unrelation.NewMongo() if err != nil { @@ -129,15 +129,15 @@ func Test_BatchInsertChat2DB(t *testing.T) { } func GetDB() *commonMsgDatabase { - config.Config.Mongo.DBAddress = []string{"192.168.44.128:37017"} - config.Config.Mongo.DBTimeout = 60 - config.Config.Mongo.DBDatabase = "openIM" - config.Config.Mongo.DBSource = "admin" - config.Config.Mongo.DBUserName = "root" - config.Config.Mongo.DBPassword = "openIM123" - config.Config.Mongo.DBMaxPoolSize = 100 - config.Config.Mongo.DBRetainChatRecords = 3650 - config.Config.Mongo.ChatRecordsClearTime = "0 2 * * 3" + config.Config.Mongo.Address = []string{"192.168.44.128:37017"} + config.Config.Mongo.Timeout = 60 + config.Config.Mongo.Database = "openIM" + config.Config.Mongo.Source = "admin" + config.Config.Mongo.Username = "root" + config.Config.Mongo.Password = "openIM123" + config.Config.Mongo.MaxPoolSize = 100 + config.Config.RetainChatRecords = 3650 + config.Config.ChatRecordsClearTime = "0 2 * * 3" mongo, err := unrelation.NewMongo() if err != nil {