Skip to content

Commit

Permalink
update status page relate doc (#1532)
Browse files Browse the repository at this point in the history
Signed-off-by: tomsun28 <tomsun28@outlook.com>
Co-authored-by: Logic <zqr10159@dromara.org>
  • Loading branch information
tomsun28 and zqr10159 authored Feb 3, 2024
1 parent 9c229f5 commit ba70407
Show file tree
Hide file tree
Showing 77 changed files with 137 additions and 124 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@

## HertzBeat | [中文文档](README_CN.md)

> An open-source, real-time monitoring system with custom-monitoring, performance-cluster, prometheus-compatible and agentless. | 易用友好的开源实时监控告警系统,无需Agent,高性能集群,兼容Prometheus,强大自定义监控能力.
> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
> 实时监控系统,无需Agent,性能集群,兼容Prometheus,自定义监控和状态页构建能力。
[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr)
[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/)
Expand All @@ -25,7 +26,7 @@

## 🎡 <font color="green">Introduction</font>

[HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring system with custom monitoring, high performance cluster, prometheus-compatible and agentless capabilities.
[HertzBeat](https://github.com/dromara/hertzbeat) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building capabilities.

### Features

Expand All @@ -35,7 +36,7 @@
* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on webui.
* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration.
* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`.

* Provides powerful status page building capabilities, easily communicate the real-time status of your service to users.

> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.
> We also provide **[SaaS Monitoring Cloud](https://console.tancloud.cn)**, users no longer need to deploy a cumbersome monitoring system to monitor their resources. **[Get started online for free](https://console.tancloud.cn)**.
Expand All @@ -44,6 +45,8 @@

![hertzbeat](home/static/img/home/1.png)

![hertzbeat](home/static/img/home/status.png)

![hertzbeat](home/static/img/home/9.png)

----
Expand Down
9 changes: 6 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## HertzBeat 赫兹跳动 | [English Documentation](README.md)

> 易用友好的开源实时监控告警系统,无需Agent,高性能集群,兼容Prometheus,强大自定义监控能力
> 实时监控系统,无需Agent,性能集群,兼容Prometheus,自定义监控和状态页构建能力
[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr)
[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/)
Expand All @@ -26,7 +26,7 @@

## 🎡 <font color="green">介绍</font>

[HertzBeat 赫兹跳动](https://github.com/dromara/hertzbeat) 是一个拥有强大自定义监控能力,高性能集群,兼容 Prometheus,无需 Agent 的开源实时监控告警系统
[HertzBeat 赫兹跳动](https://github.com/dromara/hertzbeat) 是一个易用友好的开源实时监控告警系统,无需 Agent,高性能集群,兼容 Prometheus,提供强大的自定义监控和状态页构建能力

### 特点

Expand All @@ -35,7 +35,8 @@
-`Http, Jmx, Ssh, Snmp, Jdbc, Prometheus` 等协议规范可配置化,只需在浏览器配置监控模版 `YML` 就能使用这些协议去自定义采集想要的指标。您相信只需配置下就能立刻适配一款 `K8s``Docker` 等新的监控类型吗?
- 兼容 `Prometheus` 的系统生态并且更多,只需页面操作就可以监控 `Prometheus` 所能监控的。
- 高性能,支持多采集器集群横向扩展,支持多隔离网络监控,云边协同。
- 自由的告警阈值规则,`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。
- 自由的告警阈值规则,`邮件` `Discord` `Slack` `Telegram` `钉钉` `微信` `飞书` `短信` `Webhook` `Server酱` 等方式消息及时送达。
- 提供强大的状态页构建能力,轻松向用户传达您产品服务的实时状态。


> `HertzBeat`的强大自定义,多类型支持,高性能,易扩展,低耦合,希望能帮助用户快速搭建自有监控系统。
Expand All @@ -45,6 +46,8 @@

![hertzbeat](home/static/img/home/1.png)

![hertzbeat](home/static/img/home/status.png)

![hertzbeat](home/static/img/home/9.png)

----
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-http-default.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
label: true
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-http-example-hertzbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ metrics:
priority: 0
# collect metrics content
fields:
# metrics content contains field-metric name, type-metric type:0-number,1-string, instance-if is metrics, unit-metric unit('%','ms','MB')
# metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB')
- field: app
type: 1
label: true
Expand Down
6 changes: 3 additions & 3 deletions home/docs/advanced/extend-http-example-token.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ metrics:
priority: 0
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: token
type: 1
- field: refreshToken
Expand Down Expand Up @@ -305,7 +305,7 @@ metrics:
priority: 0
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: token
type: 1
- field: refreshToken
Expand Down Expand Up @@ -342,7 +342,7 @@ metrics:
priority: 1
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: category
type: 1
- field: app
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-http-jsonpath.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: type
type: 1
label: true
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-http.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
label: true
Expand Down
6 changes: 3 additions & 3 deletions home/docs/advanced/extend-jdbc.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: version
type: 1
label: true
Expand Down Expand Up @@ -166,7 +166,7 @@ metrics:
- name: status
priority: 1
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: threads_created
type: 0
- field: threads_connected
Expand Down Expand Up @@ -207,7 +207,7 @@ metrics:
- name: innodb
priority: 2
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: innodb_data_reads
type: 0
unit: times
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-jmx.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ metrics:
priority: 0
# collect metrics content
fields:
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics unique identifier
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
- field: VmName
type: 1
- field: VmVendor
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-point.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ metrics:
priority: 0
# collect metrics content
fields:
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics unique identifier
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
- field: responseTime
type: 0
unit: ms
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-snmp.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ metrics:
priority: 0
# collect metrics content
fields:
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), instance-if is metrics unique identifier
# field-metric name, type-metric type(0-number,1-string), unit-metric unit('%','ms','MB'), label-if is metrics label
- field: name
type: 1
- field: descr
Expand Down
6 changes: 3 additions & 3 deletions home/docs/advanced/extend-ssh.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
label: true
Expand All @@ -144,7 +144,7 @@ metrics:
- name: cpu
priority: 1
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: info
type: 1
- field: cores
Expand Down Expand Up @@ -174,7 +174,7 @@ metrics:
- name: memory
priority: 2
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: total
type: 0
unit: Mb
Expand Down
2 changes: 1 addition & 1 deletion home/docs/advanced/extend-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ metrics:
priority: 0
# collect metrics content
fields:
# metrics content contains field-metric name, type-metric type:0-number,1-string, instance-if is metrics, unit-metric unit('%','ms','MB')
# metrics content contains field-metric name, type-metric type:0-number,1-string, label-if is metrics label, unit-metric unit('%','ms','MB')
- field: app
type: 1
label: true
Expand Down
5 changes: 3 additions & 2 deletions home/docs/introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Introduce
slug: /
---

> An open-source, real-time monitoring system with custom-monitoring, performance-cluster, prometheus-compatible and agentless.
> A real-time monitoring system with agentless, performance cluster, prometheus-compatible, custom monitoring and status page building capabilities.
[![Discord](https://img.shields.io/badge/Chat-Discord-7289DA?logo=discord)](https://discord.gg/Fb6M73htGr)
[![Reddit](https://img.shields.io/badge/Reddit-Community-7289DA?logo=reddit)](https://www.reddit.com/r/hertzbeat/)
Expand All @@ -22,7 +22,7 @@ slug: /

## 🎡 <font color="green">Introduction</font>

[HertzBeat](https://github.com/dromara/hertzbeat) is an open source, real-time monitoring system with custom monitoring, high performance cluster, prometheus-compatible and agentless capabilities.
[HertzBeat](https://github.com/dromara/hertzbeat) is an easy-to-use, open source, real-time monitoring system with agentless, high performance cluster, prometheus-compatible, offers powerful custom monitoring and status page building capabilities.

### Features

Expand All @@ -32,6 +32,7 @@ slug: /
* Compatible with the `Prometheus` ecosystem and more, can monitoring what `Prometheus` can monitoring with few clicks on webui.
* High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration.
* Provides flexible alarm threshold rules and timely notifications delivered via `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`.
* Provides powerful status page building capabilities, easily communicate the real-time status of your service to users.


> HertzBeat's powerful customization, multi-type support, high performance, easy expansion, and low coupling, aims to help users quickly build their own monitoring system.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
instance: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ metrics:
- name: summary
priority: 0
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: responseTime
type: 0
unit: ms
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ metrics:
priority: 0
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: token
type: 1
- field: refreshToken
Expand Down Expand Up @@ -298,7 +298,7 @@ metrics:
priority: 0
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: token
type: 1
- field: refreshToken
Expand Down Expand Up @@ -335,7 +335,7 @@ metrics:
priority: 1
# Specific monitoring metrics in the metrics
fields:
# metric information includes field name type field type: 0-number, 1-string whether instance is the primary key of the instance unit: metric unit
# metric information includes field name type field type: 0-number, 1-string , label-if is metrics label, unit: metric unit
- field: category
type: 1
- field: app
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: type
type: 1
instance: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) nstance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
instance: true
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: version
type: 1
instance: true
Expand Down Expand Up @@ -165,7 +165,7 @@ metrics:
- name: status
priority: 1
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: threads_created
type: 0
- field: threads_connected
Expand Down Expand Up @@ -206,7 +206,7 @@ metrics:
- name: innodb
priority: 2
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: innodb_data_reads
type: 0
unit: times
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ metrics:
priority: 0
# metrics fields list
fields:
# Metric information include field: name type: field type(0-number: number, 1-string: string) instance: primary key of instance or not unit: Metric unit
# Metric information include field: name type: field type(0-number: number, 1-string: string) label-if is metrics label unit: Metric unit
- field: hostname
type: 1
instance: true
Expand Down
Loading

0 comments on commit ba70407

Please sign in to comment.