Skip to content

Suggestion for Alarm Documentation Improvement #2224

@tigercl

Description

@tigercl
  1. The Chinese alarm documentation is inconsistent with the English version.
    CN: https://www.emqx.io/docs/zh/latest/observability/alarms.html#%E5%91%8A%E8%AD%A6
    EN: https://www.emqx.io/docs/en/latest/observability/alarms.html#alarm

  2. There are many errors in the Chinese alarm documentation. For example, the sysmon.top.db_password configuration item is explained as the password for the PostgreSQL database, but why would an alarm be related to PostgreSQL?

  3. The Chinese alarm documentation lacks explanations for alarm types. The English alarm documentation provides relatively simple explanations for alarm types. For example, what does it mean when a conn_congestion alarm appears, and what measures should I take? Should I optimize it myself or seek technical support?

  4. Should long_gc, long_schedule, large_heap, busy_port not be considered alarms? Therefore, their configuration descriptions should not appear in the alarm documentation?


This issue was automatically translated from Chinese.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions