Merge pull request #9872 from zmstone/0131-improve-help-text

docs: improve docs for system monitoring config
This commit is contained in:
zhongwencool 2023-02-02 14:45:03 +08:00 committed by GitHub
commit e5bc787467
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 10 deletions

View File

@ -188,8 +188,12 @@ emqx_schema {
sysmon_vm_long_gc {
desc {
en: "Enable Long GC monitoring."
zh: "启用长垃圾回收监控。"
en: """When an Erlang process spends long time to perform garbage collection, a warning level <code>long_gc</code> log is emitted,
and an MQTT message is published to the system topic <code>$SYS/sysmon/long_gc</code>.
"""
zh: """当系统检测到某个 Erlang 进程垃圾回收占用过长时间,会触发一条带有 <code>long_gc</code> 关键字的日志。
同时还会发布一条主题为 <code>$SYS/sysmon/long_gc</code> 的 MQTT 系统消息。
"""
}
label {
en: "Enable Long GC monitoring."
@ -199,8 +203,12 @@ emqx_schema {
sysmon_vm_long_schedule {
desc {
en: "Enable Long Schedule monitoring."
zh: "启用长调度监控。"
en: """When the Erlang VM detect a task scheduled for too long, a warning level 'long_schedule' log is emitted,
and an MQTT message is published to the system topic <code>$SYS/sysmon/long_schedule</code>.
"""
zh: """启用后,如果 Erlang VM 调度器出现某个任务占用时间过长时,会触发一条带有 'long_schedule' 关键字的日志。
同时还会发布一条主题为 <code>$SYS/sysmon/long_schedule</code> 的 MQTT 系统消息。
"""
}
label {
en: "Enable Long Schedule monitoring."
@ -210,8 +218,13 @@ emqx_schema {
sysmon_vm_large_heap {
desc {
en: "Enable Large Heap monitoring."
zh: "启用大 heap 监控。"
en: """When an Erlang process consumed a large amount of memory for its heap space,
the system will write a warning level <code>large_heap</code> log, and an MQTT message is published to
the system topic <code>$SYS/sysmon/large_heap</code>.
"""
zh: """启用后,当一个 Erlang 进程申请了大量内存,系统会触发一条带有 <code>large_heap</code> 关键字的
warning 级别日志。同时还会发布一条主题为 <code>$SYS/sysmon/busy_dist_port</code> 的 MQTT 系统消息。
"""
}
label {
en: "Enable Large Heap monitoring."
@ -221,8 +234,13 @@ emqx_schema {
sysmon_vm_busy_dist_port {
desc {
en: "Enable Busy Distribution Port monitoring."
zh: "启用分布式端口过忙监控。"
en: """When the RPC connection used to communicate with other nodes in the cluster is overloaded,
there will be a <code>busy_dist_port</code> warning log,
and an MQTT message is published to system topic <code>$SYS/sysmon/busy_dist_port</code>.
"""
zh: """启用后,当用于集群接点之间 RPC 的连接过忙时,会触发一条带有 <code>busy_dist_port</code> 关键字的 warning 级别日志。
同时还会发布一条主题为 <code>$SYS/sysmon/busy_dist_port</code> 的 MQTT 系统消息。
"""
}
label {
en: "Enable Busy Distribution Port monitoring."
@ -232,8 +250,12 @@ emqx_schema {
sysmon_vm_busy_port {
desc {
en: "Enable Busy Port monitoring."
zh: "启用端口过忙监控。"
en: """When a port (e.g. TCP socket) is overloaded, there will be a <code>busy_port</code> warning log,
and an MQTT message is published to the system topic <code>$SYS/sysmon/busy_port</code>.
"""
zh: """当一个系统接口(例如 TCP socket过忙会触发一条带有 <code>busy_port</code> 关键字的 warning 级别的日志。
同时还会发布一条主题为 <code>$SYS/sysmon/busy_port</code> 的 MQTT 系统消息。
"""
}
label {
en: "Enable Busy Port monitoring."