同步操作将从 Bwar/Nebula 强制同步,此操作会覆盖自 Fork 仓库以来所做的任何修改,且无法恢复!!!
确定后同步将在后台操作,完成时将刷新页面,请耐心等待。
Nebula的配置文件为json格式,可读性、可扩展性和易维护性都很好,同时也非常方便通过配置中心远程管理。选择json格式配置文件还有很重要的一点,因为CJsonObject让使用json如使用C++自己的结构体那般方便,随心所欲(关注一下CJsonObject,这也许会是你见过的最为简单易用的C++json库)。
讲解配置文件前先明确几个概念:分布式服务集群(distributed service cluster)、节点(node)、接入(access)。每个启动的Server(可以理解为一个Manager进程)称为一个节点(node);每个节点都会向一个Beacon或一组存在主备关系的多个Beacon节点发起注册,由同一个或一组Beacon管理的所有节点称为Nebula cluster。从Nebula cluster外部访问Nebula cluster需经由某一个或一组具有相同节点类型的节点,这些接收外部访问的动作称为接入,接收外部访问的节点称为接入节点。
Nebula项目提供的是配置文件的模板,每个基于Nebula的项目(如NebulaBeacon、NebulaInterface等)都有各自具体的配置文件,可以理解为Nebula提供的配置文件是类,基于Nebula个项目的配置文件是类的对象。如果基于Nebula开发了自己全新的Server服务,也可以给予Nebula的配置文件改一个属于Server自己的配置文件。先来看看配置文件的内容再来逐项配置说明:
{
"//node_type": "节点类型:ACCESS,LOGIC,PROXY,CENTER等,由业务层定义",
"node_type": "ACCESS",
"//host": "系统内各Server之间通信绑定的IP(Server to Server)",
"host": "192.168.18.81",
"//port": "系统内各Server之间通信监听的端口",
"port": 9987,
"//access_host": "对系统外提供服务绑定的IP(Client to Server),若不提供对外服务,则无需配置",
"access_host": "192.168.18.81",
"//access_port": "对系统外提供服务监听的端口",
"access_port": 9988,
"//access_codec": "接入端编解码器,目前支持CODEC_PRIVATE(4),CODEC_HTTP(3),CODEC_PROTOBUF(2)",
"access_codec": 4,
"gateway": "113.102.157.188",
"gateway_port": 9988,
"//server_name": "异步事件驱动Server",
"server_name": "AsyncServer",
"//worker_num": "进程数量",
"worker_num": 10,
"//worker_capacity": "子进程最大工作负荷",
"worker_capacity": 1000000,
"//cpu_affinity":"是否设置进程CPU亲和度(绑定CPU)",
"cpu_affinity":false,
"//config_path": "配置文件路径(相对路径)",
"config_path": "conf/",
"//log_path": "日志文件路径(相对路径)",
"log_path": "log/",
"//max_log_file_num": "最大日志文件数量,用于日志文件滚动",
"max_log_file_num": 5,
"//max_log_file_size": "单个日志文件大小限制",
"max_log_file_size": 20480000,
"log_levels": { "FATAL": 0, "CRITICAL": 1, "ERROR": 2, "NOTICE": 3, "WARNING": 4, "INFO": 5, "DEBUG": 6, "TRACE": 7 },
"log_level": 7,
"net_log_level": 6,
"//permission": "限制。addr_permit为连接限制,限制每个IP在统计时间内连接次数;uin_permit为消息数量限制,限制每个用户在单位统计时间内发送消息数量。",
"permission": {
"addr_permit": { "stat_interval": 60.0, "permit_num": 1000000000 },
"uin_permit": { "stat_interval": 60.0, "permit_num": 600000000 }
},
"//io_timeout": "网络IO(连接)超时设置(单位:秒)小数点后面至少保留一位",
"io_timeout": 300.0,
"//step_timeout": "步骤超时设置(单位:秒)小数点后面至少保留一位",
"step_timeout": 1.5,
"boot_load": {
"cmd": [
"//step_timeout": "步骤超时设置(单位:秒)小数点后面至少保留一位",
"step_timeout": 1.5,
"log_levels": { "FATAL": 0, "CRITICAL": 1, "ERROR": 2, "NOTICE": 3, "WARNING": 4, "INFO": 5, "DEBUG": 6, "TRACE": 7 },
"log_level": 7,
"net_log_level": 6,
"//with_ssl": "SSL配置(可为空),路径为相对${WorkPath}的相对路径,公钥文件和私钥文件均为PEM格式",
"with_ssl": {
"config_path": "conf/ssl",
"cert_file": "20180623143147.pem",
"key_file": "20180623143147.key"
},
"//data_report": "数据上报时间间隔,无统计数据时不上报",
"data_report": 60,
"//refresh_interval": "刷新Server配置,检查、加载插件动态库时间周期(周期时间长短视服务器忙闲而定)",
"refresh_interval": 60,
"load_config":{
"manager":{
},
"worker":{
"boot_load": {
"cmd": [
{ "cmd": 1001, "class": "neb::CmdHello" },
{ "cmd": 1003, "class": "neb::CmdDbAgent" }
],
"module": [
{ "path": "neb/switch", "class": "neb::ModuleSwitch" },
{ "path": "neb/hello", "class": "neb::ModuleHello" }
]
},
"dynamic_loading": [{
"so_path": "plugins/User.so",
"load": false,
"version": "1.0",
"cmd": [
{ "cmd": 2001, "class": "neb::CmdUserLogin" },
{ "cmd": 2003, "class": "neb::CmdUserLogout" }
],
"module": [
{ "path": "im/user/login", "class": "neb::ModuleLogin" },
{ "path": "im/user/logout", "class": "neb::ModuleLogout" }
],
"session":["im::SessionUser", "im::SessionGroup"],
"step":["im::StepLogin", "im::StepLogout", "im::StepP2pChat"],
"matrix":[],
"chain":[]
},
{
"so_path": "plugins/ChatMsg.so",
"load": false,
"version": "1.0",
"cmd": [
{ "cmd": 2001, "class": "neb::CmdChat" }
],
"module": [],
"session":[],
"step":[],
"matrix":[],
"chain":[]
}
],
"runtime":{
"chains":{
"chain_1":["step1", "matrix1", ["step2A", "step2B", "step2C"], "step3", "matrix2"],
"chain_2":[]
}
}
},
"loader":{
* node_type 节点类型,由业务层定义,框架把节点类型当字符串处理,用于标识若干(数量不限)服务节点,节点类型字符串建议全大写字母。在Beacon配置节点订阅关系就是通过此项节点类型配置来实现。比如,有3个Server的节点类型配置为“ACCESS”,另有6个Server的节点类型配置为“LOGIC”,在Beacon配置了ACCESS类型的节点订阅LOGIC类型节点信息,那么当有任意LOGIC类型上线、下线时,所有ACCESS类型的节点都会收到通知,ACCESS收到通知后会自动更新内存里存储的LOGIC节点信息。
* access_host 对系统外提供接入服务绑定的IP(Client to Server),若当前节点不提供对外接入服务,则可以直接删除这项配置。
* access_port 对系统外提供接入服务监听的端口,若当前节点不提供对外接入服务,则可以直接删除这项配置。
* access_codec 对外接入服务的编解码器。目前支持CODEC_PRIVATE(4),CODEC_HTTP(3),CODEC_PROTOBUF(2),且只能配置一种编解码器,后续有可能在同一个端口提供多种协议编解码服务。若当前节点不提供对外接入服务,则可以直接删除这项配置。
* gateway 网关服务地址,用于客户端路由和负载均衡。gateway和gateway_port提供的是预先通过请求某个接口获取接入服务地址的负载均衡方式,因每个节点的负载都可以从Beacon获取到,客户端发业务请求前先通过一个固定接口查询需将正式请求发往哪个(些)接入节点,得到接入节点地址后再发业务请求。为什么不直接返回access_host、access_port?因为这两个是节点实际绑定的地址和监听的端口,外部不一定能直接访问(很可能也是内网IP和端口),比如需要通过交换机或防火墙,而交换机或防火墙是通过端口映射的方式到access_host、access_port的,那么客户端需要获取的是映射前暴露在外网的地址和端口,此时gateway和gateway_port的作用就体现出来了。假设接入服务前端还有一层类似LVS的外部负载均衡服务,只需把access_host、access_port配置到负载均衡服务即可,gateway和gateway_port不会用到。如果access_host和access_port是外部客户端可以直接访问的,则gateway配置的地址与access_host相同,gateway_port与access_port相同。
* gateway_port 网关服务端口。
* host 集群内部通信地址。
* port 集群内部通信端口。host:port组成的字符串在集群内唯一标识一个节点,用作管理层面(与Beacon通信)名字服务的节点名字。host:port.workerindex组成的字符串在集群内唯一标识一个节点的一个Worker进程,用作数据层面(也即业务层面,除Beacon之外的节点间通信)名字服务的节点Worker名字。
* server_name 节点Server进程名,方便在服务器中标识和管理,在集群管理和节点通信中都不会用到。通俗一点讲,这是给人用的不是给机器用的。
* worker_num Worker进程数量,每个节点由一个Manager进程和若干个Worker进程构成。通常,如果某台机器只部署了一个Nebula服务并且主要是给这个服务使用的,为了更充分使用机器资源,将worker_num配置成与cpu核数相同。
* with_loader 是否启动loader进程。Loader进程用于做本地数据存储,大部分IO密集型的应用不会用到,所以默认不会启动Loader进程。
* worker_capacity 进程容量,用于过载保护。进程负载 = Channel数量 * 系数 + Step数量 * 系数。这个计算公式会根据需要和合理性做调整。当进程负载达到进程容量限制时会拒绝新的连接。
* cpu_affinity CPU亲和度,为true时,Worker进程会均匀地绑定到CPU核。默认为false,不绑定。
* config_path 配置文件存储路径,相对于NEBULA_HOME的路径。
* log_path 日志文件存储路径,相对于NEBULA_HOME的路径。
* max_log_file_num 最大日志文件数量,用于日志文件滚动,超出这个数量的日志文件将会被直接删除。
* access_codec 对外接入服务的编解码器。目前支持CODEC_PRIVATE(4),CODEC_HTTP(3),CODEC_PROTOBUF(2),且只能配置一种编解码器,后续有可能在同一个端口提供多种协议编解码服务。若当前节点不提供对外接入服务,则可以直接删除这项配置。
* gateway 网关服务地址,用于客户端路由和负载均衡。gateway和gateway_port提供的是预先通过请求某个接口获取接入服务地址的负载均衡方式,因每个节点的负载都可以从Beacon获取到,客户端发业务请求前先通过一个固定接口查询需将正式请求发往哪个(些)接入节点,得到接入节点地址后再发业务请求。为什么不直接返回access_host、access_port?因为这两个是节点实际绑定的地址和监听的端口,外部不一定能直接访问(很可能也是内网IP和端口),比如需要通过交换机或防火墙,而交换机或防火墙是通过端口映射的方式到access_host、access_port的,那么客户端需要获取的是映射前暴露在外网的地址和端口,此时gateway和gateway_port的作用就体现出来了。假设接入服务前端还有一层类似LVS的外部负载均衡服务,只需把access_host、access_port配置到负载均衡服务即可,gateway和gateway_port不会用到。如果access_host和access_port是外部客户端可以直接访问的,则gateway配置的地址与access_host相同,gateway_port与access_port相同。
* gateway_port 网关服务端口。
* host 集群内部通信地址。
* port 集群内部通信端口。host:port组成的字符串在集群内唯一标识一个节点,用作管理层面(与Beacon通信)名字服务的节点名字。host:port.workerindex组成的字符串在集群内唯一标识一个节点的一个Worker进程,用作数据层面(也即业务层面,除Beacon之外的节点间通信)名字服务的节点Worker名字。
* server_name 节点Server进程名,方便在服务器中标识和管理,在集群管理和节点通信中都不会用到。通俗一点讲,这是给人用的不是给机器用的。
* worker_num Worker进程数量,每个节点由一个Manager进程和若干个Worker进程构成。通常,如果某台机器只部署了一个Nebula服务并且主要是给这个服务使用的,为了更充分使用机器资源,将worker_num配置成与cpu核数相同。
* with_loader 是否启动loader进程。Loader进程用于做本地数据存储,大部分IO密集型的应用不会用到,所以默认不会启动Loader进程。
* worker_capacity 进程容量,用于过载保护。进程负载 = Channel数量 * 系数 + Step数量 * 系数。这个计算公式会根据需要和合理性做调整。当进程负载达到进程容量限制时会拒绝新的连接。
* cpu_affinity CPU亲和度,为true时,Worker进程会均匀地绑定到CPU核。默认为false,不绑定。
* config_path 配置文件存储路径,相对于NEBULA_HOME的路径。
* log_path 日志文件存储路径,相对于NEBULA_HOME的路径。
* max_log_file_num 最大日志文件数量,用于日志文件滚动,超出这个数量的日志文件将会被直接删除。
* max_log_file_size 单个日志文件大小限制,用于日志文件滚动,超出这个限制将滚动日志,生成一个新的日志文件。
* log_levels 日志级别枚举,仅用于给log_level和net_log_level配置时参考。
* log_level 本地文件日志级别。框架级别的调试日志用的是LOG4_TRACE(日志量很大,部署生产时请不要打开TRACE级别日志),建议业务的调试日志用LOG4_DEBUG。
* net_log_level 发到LOGTRACE日志跟踪服务的网络日志级别。
* permission 连接或消息发送频率限制。addr_permit为连接限制,限制每个IP在统计时间内连接次数,超出permit_num次数限制的连接会被直接拒绝;uin_permit为消息数量限制,限制每个用户在单位统计时间内permit_num发送消息数量,超出限制数量的消息会被直接丢弃。stat_interval到了之后重新计算。
* io_timeout 网络IO(连接)超时设置(单位:秒)小数点后面至少保留一位,用于触发连接的有效性检查。如果在到达超时时间前连接有数据收或发过,则从最后一次收发数据时间开始重新计算超时时间;如果超时时间到达却一直没有数据收发过,有三种处理情况:(1) 需要做应用层心跳检查,自动发送心跳包,心跳包得到响应,连接得以保持,重新计算超时时间;(2) 需要做应用层心跳检查,自动发送心跳包,心跳包未得到响应,立即断开连接,回收连接所分配资源;(3) 无须做应用层心跳检查,立即断开连接,回收连接所分配资源。
* step_timeout 步骤超时设置(单位:秒)小数点后面至少保留一位,用于请求发出后等待响应的默认超时等待。在代码层可以为每一个发出的请求设置等待超时,通常为Step类的最后一个参数,如果这个参数为缺省值,则配置文件里的step_timeout会作为这个Step发出请求后等待响应的超时时间。
* with_ssl 配置接入服务的对外连接是否需要SSL传输加密,如果需要则配置ssl配置文件路径和相关文件名。
* data_report 数据上报时间间隔,无统计数据时不上报。
* refresh_interval 刷新Server配置,检查、加载配置或加载卸载插件动态库时间周期。
* load_config 功能模块加载。功能模块分manager、worker、loader进程的功能模块,分别加载到对应类型的进程里。
* boot_load 服务启动加载的处理模块入口。Nebula框架会被编译成动态库 libnebula.so,基于Nebula框架的Server需要写个main函数并编译链接成一个二进制文件,比如NebulaBeacon,还有一些不需要做动态加载的模块会一起编译链接到这个二进制文件里,而这些模块是Nebula框架未知的(libnebula.so早于任何一个server二进制文件存在),boot_load就是为这些模块加载使用的。boot_load里的配置说明见下文描述动态加载配置说明。
#### 控制中心配置
* beacon 控制中心地址和端口,有几个控制中心节点就配置几条。如果无须控制中心,则配置为空。
#### 动态加载配置
  动态加载配置dynamic_loading是一个json数组,每个数组元素都是一个SO动态库插件。每个插件的配置项说明如下:
```json
"dynamic_loading": [{
"so_path": "plugins/User.so",
"load": false,
"version": 1,
"cmd": [
{ "cmd": 2001, "class": "neb::CmdUserLogin" },
{ "cmd": 2003, "class": "neb::CmdUserLogout" }
],
"module": [
{ "path": "im/user/login", "class": "neb::ModuleLogin" },
{ "path": "im/user/logout", "class": "neb::ModuleLogout" }
],
"session":["im::SessionUser", "im::SessionGroup"],
"step":["im::StepLogin", "im::StepLogout", "im::StepP2pChat"],
"model":[]
}
]
自定义配置是业务层所需的配置,通常会独立定义配置文件存放在conf路径下。这里的自定义配置指的不是那种业务独立定义的配置文件,而是以“custom”为key的json嵌入到Nebula框架配置文件中的自定义配置。这样配置有什么好处?因为所有的业务代码类都是Actor的派生类,把自定义配置嵌入到框架的配置文件中,只需调用GetCustomConf()方法即可获得配置内容,这个方法是Actor类的成员方法,读取配置就跟访问类自己的成员一样随时随地随心所欲。虽然把自定义配置嵌入到Nebula框架配置文件里非常方便,但也不要滥用,如果什么配置都往这里放会使得框架配置文件变得非常大,可读性和可维护性都变差。建议把许多业务功能模块都会用到或使用频率非常高,配置量不是太大的配置嵌入到框架配置文件里,而只有少数模块会用到,又或使用频率低,或配置内容非常庞大的应独立成其他自定义配置文件。非json格式的配置也应独立成自定义配置文件。
"custom": {}
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。