This is an automated email from the ASF dual-hosted git repository. shenghang pushed a commit to branch doc-add-status-page in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
commit 1bf782d12c0516adbb4509a0cb04c0afe3d99d87 Author: zhangshenghang <[email protected]> AuthorDate: Wed Jul 3 22:07:25 2024 +0800 [doc]add status page doc --- home/docs/help/status.md | 76 +++++++++++++++++++++ .../current/help/status.md | 73 ++++++++++++++++++++ home/static/img/docs/help/status-1.png | Bin 0 -> 34202 bytes home/static/img/docs/help/status-2.png | Bin 0 -> 49314 bytes home/static/img/docs/help/status-3.png | Bin 0 -> 81039 bytes home/static/img/docs/help/status-4.png | Bin 0 -> 24153 bytes 6 files changed, 149 insertions(+) diff --git a/home/docs/help/status.md b/home/docs/help/status.md new file mode 100644 index 000000000..1e1b8251b --- /dev/null +++ b/home/docs/help/status.md @@ -0,0 +1,76 @@ +Here is the English translation of the provided text: + +--- + +id: status +title: Status Page +sidebar_label: Status Page +keywords: [Open Source Monitoring System, Open Source Website Monitoring, Status Page] +--- + +Quickly build a powerful status page with HertzBeat to easily communicate the real-time status of your product services to users. For example, see GitHub's service status page [https://www.githubstatus.com](https://www.githubstatus.com). + +It supports the linkage synchronization between component status and monitoring status, provides a fault event maintenance management mechanism, and more. This enhances your transparency and professionalism, builds user trust, and reduces communication costs. + +## 1. Set Organization Information + +The fields that need to be filled in are as follows: + +| Field Name | Field Description | Example | +|--------------|--------------------------------------------------|-----------------------------------------------------------------------------------------------------| +| Organization Name | Name of the organization | HertzBeat | +| Organization Description | Detailed description of the organization | Apache HertzBeat (incubating) is an easy-to-use and user-friendly open-source real-time monitoring and alerting system, no agent required, high-performance cluster, compatible with Prometheus, providing powerful custom monitoring and status page building capabilities. | +| Website Link | URL of the organization's website for more information | https://hertzbeat.apache.org/ | +| Logo Image | Path or URL of the organization's official logo image, preferably in .svg format | https://hertzbeat.apache.org/zh-cn/img/hertzbeat-logo.svg | +| Feedback Address | Address to receive feedback | https://github.com/apache/hertzbeat/issues | +| Theme Color | Main color tone of the status page | Click to select on the page | + +After filling in the organization information, click `Confirm`. + + + +## 2. Add Component + +After adding a component, the status page will display the status information of the component. + +Click `Add Component` to add the component to be monitored and fill in the following fields: + +| Field Name | Field Description | Example | +|-------------------|-----------------------------------------------------------------------------------------------------------|------------------------------------------| +| Service Component | Name of the component service | Development Environment ElasticSearch | +| Component Description | Detailed description of the component service | Development environment, ElasticSearch (ip:192.168.1.1) | +| Service Status Calculation Method | Method of calculating the service status of the component.<br/>Automatic Calculation: Automatically calculate the status based on the monitored status of the component.<br/>Manual Setting: Manually configure the component status. | Automatic Calculation / Manual Setting (Choose one) | +| Matching Tag | Status calculation associated tag, use the availability status data of all monitors associated with the tag to calculate the service status of the component. | Select the component tag on the page | + +### Set Status Calculation Time + +> Note: The service status is calculated every 300 seconds by default. + +Modify `application.yml`: + +```yaml +status: + calculate: + interval: 60 +``` + + + +## 3. Maintain Events + +When an event occurs, you can publish a notification on the status page. + +Click `Publish Event` + + + +| Field Name | Field Description | Example | +|--------------|-------------------------------------------------|------------------------------------------------------------| +| Event Name | Title of the event, should clearly reflect the core content of the event | "Server Downtime Event - April 5, 2023" | +| Affected Component | Select the components affected by this event | Select on the page | +| Process Status | Set the current status of the event for tracking the progress. Optional values: Investigating / Confirmed / Monitoring / Resolved | Confirmed | +| Publish Message | Official notification to convey to relevant parties, including event details, impact assessment, and countermeasures | Dear All, there is an issue with the development environment, the developers are urgently handling it, it is expected to be fixed within two hours. Please be patient, if you have urgent matters, please contact Tom: 130xxxx0000! | + +> Note: You can publish messages multiple times to keep the team updated on the current status. + + \ No newline at end of file diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md new file mode 100644 index 000000000..ebae858ee --- /dev/null +++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/status.md @@ -0,0 +1,73 @@ +--- +id: status +title: 状态页面 +sidebar_label: 状态页面 +keywords: [开源监控系统, 开源网站监控, 状态页面] +--- + +利用 HertzBeat 快速构建强大的状态页面，轻松向用户传达您产品服务的实时状态。例如，Github 的服务状态页 [https://www.githubstatus.com](https://www.githubstatus.com)。 + +支持状态页组件状态和监控状态联动同步，提供故障事件维护管理机制等功能。提高您的透明度和专业度，增强用户信任，降低沟通成本。 + +## 1. 设置组织信息 + +需要填写的字段如下： + +| 字段名称 | 字段说明 | 举例 | +|------|-----------------------------------------|---------------------------------------------------------------------------------------------------| +| 组织名称 | 组织的名称 | HertzBeat | +| 组织介绍 | 组织的详细介绍 | Apache HertzBeat (incubating) 是一个易用友好的开源实时监控告警系统，无需 Agent，高性能集群，兼容 Prometheus，提供强大的自定义监控和状态页构建能力。 | +| 网站链接 | 组织网站的 URL，便于访问者获取更多信息 | https://hertzbeat.apache.org/ | +| 标志图片 | 组织官方标志或 Logo 的图片文件路径或 URL，建议使用 .svg 格式 | https://hertzbeat.apache.org/zh-cn/img/hertzbeat-logo.svg | +| 反馈地址 | 接收问题反馈的地址 | https://github.com/apache/hertzbeat/issues | +| 主题颜色 | 状态页面的主色调。 | 在页面中点击选择 | + +填写完组织信息后，点击 `确定`。 + + + +## 2. 新增组件 + +新增组件后，状态页面将显示组件的状态信息。 + +点击 `新增组件` 添加需要监控的组件，并填写以下字段： + +| 字段名称 | 字段说明 | 举例 | +|------|-----------------------------------------------------------------------------------------|------------------------------------| +| 服务组件 | 组件服务名称 | 开发环境 ElasticSearch | +| 组件描述 | 组件服务的详细描述信息 | 开发环境，ElasticSearch (ip:192.168.1.1) | +| 服务状态统计方式 | 计算组件服务状态的方式。<br/>自动计算：根据组件监控的状态自动计算显示状态。<br/>手动设置：手动配置组件状态。 | 自动计算 / 手动设置 二选一 | +| 匹配标签 | 状态计算关联标签，使用标签关联的所有监控可用性状态数据来计算组件服务状态。 | 在页面选择组件的标签 | + +### 设置状态统计时间 + +> 提示：服务状态默认每 300 秒统计一次。 + +修改 `application.yml`： + +```yaml +status: + calculate: + interval: 60 +``` + + + +## 3. 维护事件 + +当事件发生时，可以在状态页面发布通知。 + +点击 `发布事件` + + + +| 字段名称 | 字段说明 | 举例 | +|----------|-----------------------------------------------|------------------------------------------------| +| 事件名称 | 事件的标题，应简洁明了地反映事件的核心内容。 | "服务器宕机事件 - 2023 年 4 月 5 日" | +| 影响组件 | 选择受此事件影响的组件。 | 在页面中选择 | +| 过程状态 | 设置事件当前状态，便于追踪处理进度。可选值：调查中 / 已确认 / 观察中 / 已修复 | 已确认 | +| 发布消息 | 向相关方传达的正式通知，包括事件详情、影响评估和应对措施。 | Dear All，开发环境异常，开发人员正在紧急处理，预计两小时内修复。请耐心等待，如有紧急事项请联系 Tom：130xxxx0000！ | + +> 提示：可以多次发布消息，及时向团队汇报当前状态。 + + \ No newline at end of file diff --git a/home/static/img/docs/help/status-1.png b/home/static/img/docs/help/status-1.png new file mode 100644 index 000000000..49b922ce3 Binary files /dev/null and b/home/static/img/docs/help/status-1.png differ diff --git a/home/static/img/docs/help/status-2.png b/home/static/img/docs/help/status-2.png new file mode 100644 index 000000000..25ec13fa8 Binary files /dev/null and b/home/static/img/docs/help/status-2.png differ diff --git a/home/static/img/docs/help/status-3.png b/home/static/img/docs/help/status-3.png new file mode 100644 index 000000000..4caf444ce Binary files /dev/null and b/home/static/img/docs/help/status-3.png differ diff --git a/home/static/img/docs/help/status-4.png b/home/static/img/docs/help/status-4.png new file mode 100644 index 000000000..e8a419cd9 Binary files /dev/null and b/home/static/img/docs/help/status-4.png differ --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
