Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Translate 2022-02-11-hertzbeat document #1660

Merged
merged 2 commits into from
Mar 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
137 changes: 69 additions & 68 deletions home/blog/2022-02-11-hertzbeat.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: 开源监控告警项目HertzBeat发布并进入Dromara孵化
title: Open source monitoring and alarm project Hertz Beat is released and enters Dromara incubation
author: tom
author_title: tom
author_url: https://github.com/tomsun28
author_image_url: https://avatars.githubusercontent.com/u/24788200?s=400&v=4
tags: [opensource]
---

# 开源监控告警项目HertzBeat发布并进入Dromara孵化
# Open source monitoring and alarm project Hertz Beat is released and enters Dromara incubation

![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/web-monitor.svg)
![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/ping-connect.svg)
Expand All @@ -17,113 +17,114 @@ tags: [opensource]
![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/threshold.svg)
![tan-cloud](https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/badge/alert.svg)

**官网: [hertzbeat.com](https://hertzBeat.com) | [tancloud.cn](https://tancloud.cn)**
**Official website: [hertzbeat.com](https://hertzBeat.com) | [tancloud.cn](https://tancloud.cn)**

## 📫 前言
## 📫 Preface

> 毕业后投入很多业余时间也做了一些开源项目 [Sureness](https://github.com/dromara/sureness) , [Bootshiro](https://gitee.com/tomsun28/bootshiro) , [Issues-translate-action](https://github.com/usthe/issues-translate-action) ,
> 当时上班有空就回答网友问题,下班回家写开源代码,远程帮人看问题(大年30也看过😂),还总感觉时间不够用,当时想如果不去上班能做自己热爱的该多好,开源感觉是作为程序员的一种成就感吧。
> 想着年轻就要折腾,何况还是自己很想做的。于是乎21年底放弃激励裸辞开始全职开源了,也是第一次全职创业(虽然大概率失败,但搏一搏,单车变摩托🤓)
> 自己在APM领域做了多年,当然这次创业加开源的方向也就是老本行APM监控系统,我们开发一个支持多种监控指标(更多监控类型指标正在适配中),拥有自定义监控,支持阈值告警通知等功能,面向开发者友好的开源监控项目-HertzBeat赫兹跳动。
> 为了感谢老婆大人的全力支持,hertzbeat服务端口默认为**1157**(遥遥无期)-老婆叫尧尧,我个人希望未来的宝宝叫午期(没有话语权可能性不大😂)
> 想到很多开发者和团队拥有云上资源,可能只需要使用监控服务而并不想部署繁杂的监控系统(往往有时候那套监控系统比我们自身服务消耗的服务器资源还多😅),我们也提供了可以直接登录使用的SAAS云监控版本-[TanCloud探云](https://console.tancloud.cn)。
> 希望老铁们多多支持点赞,非常感谢。
> After graduation, I invested a lot of my spare time and did some open source projects [Sureness](https://github.com/dromara/sureness) , [Bootshiro](https://gitee.com/tomsun28/bootshiro) , [Issues-translate-action](https://github.com/usthe/issues-translate-action) ,
> When I had time at work, I answered questions from netizens. When I got home from work, I wrote open source code and helped people solve problems remotely (I also saw it on New Year’s Eve😂), but I always felt that I didn’t have enough time.
> At that time, I thought it would be great if I could do what I love instead of going to work. Open source feels like a sense of accomplishment as a programmer.
> Thinking about being young means having to struggle, not to mention it’s something you really want to do. So at the end of 21, I gave up incentives and started open source full-time. It was also the first time to start a full-time business (although there is a high probability of failure, but give it a try and the bicycle will become a motorcycle🤓)
> I have been working in the APM field for many years. Of course, the direction of starting this business and adding open source is the APM monitoring system of my old bank. We have developed an APM monitoring system that supports multiple monitoring indicators (more monitoring type indicators are being adapted) and has customized monitoring. Supports functions such as threshold alarm notifications, and is a developer-friendly open source monitoring project - Hertz Beat.
> In order to thank my wife for her full support, the hertzbeat service port defaults to **1157** (unexpectedly) - my wife's name is Yaoyao, and I personally hope that the future baby will be called Wuxia (it is unlikely without the right to speak😂)
> Thinking that many developers and teams have cloud resources, they may only need to use monitoring services and do not want to deploy complex monitoring systems (often sometimes the monitoring system consumes more server resources than our own services😅), we also provide You can directly log in to use the SAAS cloud monitoring version-[TanCloud](https://console.tancloud.cn).
> I hope you guys will give me more support and likes, thank you very much.

## 🎡 <font color="green">开始介绍</font>
## 🎡 <font color="green">Start introducing</font>

> [HertzBeat赫兹跳动](https://github.com/dromara/hertzbeat) 是一个支持网站,APIPING,端口,数据库等监控类型,拥有易用友好的可视化操作界面的开源监控告警项目。
> 我们提供了对应的[SAAS云监控版本](https://console.tancloud.cn),中小团队和个人无需再为了监控自己的网站资源,而去部署一套监控系统,[登录即可免费开始](https://console.tancloud.cn)监控之旅。
> 监控需求指标往往千奇百怪,作为一个面向开发者的开源软件,[自定义监控](https://hertzbeat.com/docs/advanced/extend-point) 肯定是要安排上的,大家可以只通过配置YML文件我们就可以自定义需要的监控类型和指标,来满足常见的个性化需求。
> HertzBeat 模块化,`manager, collector, scheduler, warehouse, alerter` 各个模块解耦合,方便大家理解上手与定制开发。
> 我们也提供了更自由化的告警阈值配置,阈值触发表达式,三种告警级别,触发次数配置,支持告警通知模版,邮件webhook等方式告警通知,实时感知业务状态。
> 更多功能欢迎登录 HertzBeat 的 [云环境TanCloud](https://console.tancloud.cn) 试用发现。
> 我们正在快速迭代中,欢迎参与加入共建项目开源生态。
> [HertzBeat](https://github.com/dromara/hertzbeat) It is an open source monitoring and alarm project that supports website, API, PING, port, database and other monitoring types, and has an easy-to-use and friendly visual operation interface.
> We provide corresponding[SAAS Cloud monitoring version](https://console.tancloud.cn), Small and medium-sized teams and individuals no longer need to deploy a monitoring system to monitor their own website resources, [Sign in to get started for free](https://console.tancloud.cn) surveillance journey.
> Monitoring demand indicators are often strange. As an open source software for developers, [Custom monitoring](https://hertzbeat.com/docs/advanced/extend-point) It must be arranged. You can customize the monitoring types and indicators you need just by configuring the YML file to meet common personalized needs.
> HertzBeat Modular, `manager, collector, scheduler, warehouse, alerter` Each module is decoupled, making it easier for everyone to understand, get started and customize development.
> We also provide more liberal alarm threshold configurations, threshold trigger expressions, three alarm levels, and trigger number configurations. We support alarm notification templates, email webhook and other methods to provide real-time awareness of business status.
> For more functions, please log in to HertzBeat [Cloud environment TanCloud](https://console.tancloud.cn) Trial discovery.
> We are iterating rapidly, and you are welcome to participate in co-building the open source ecosystem of the project.

> `HertzBeat`的多类型支持,易扩展,低耦合,希望能帮助开发者和中小团队快速搭建自有监控系统。
> `HertzBeat`With multi-type support, easy expansion and low coupling, we hope to help developers and small and medium-sized teams quickly build their own monitoring systems.

可以通过演示视频来直观了解功能: https://www.bilibili.com/video/BV1Vi4y1f7i8
You can intuitively understand the functions through demonstration videos: https://www.bilibili.com/video/BV1Vi4y1f7i8


## 🥐 模块
## 🥐 Module

- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** 提供监控管理,系统管理基础服务
> 提供对监控的管理,监控应用配置的管理,系统用户租户后台管理等。
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** 提供监控数据采集服务
> 使用通用协议远程采集获取对端指标数据。
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** 提供监控数据仓储服务
> 采集指标结果数据管理,数据落盘,查询,计算统计。
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** 提供告警服务
> 告警计算触发,任务状态联动,告警配置,告警通知。
- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** 提供可视化控制台页面
> 监控告警系统可视化控制台前端(angular+ts+zorro)
- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management and system management basic services
> Provides monitoring management, monitoring application configuration management, system user tenant backend management, etc.
- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** Provide monitoring data collection services
> Use common protocols to remotely collect and obtain peer indicator data.
- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services
> Collection of indicator results data management, data placement, query, calculation statistics.
- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** Provide alarm services
> Alarm calculation triggering, task status linkage, alarm configuration, and alarm notification.
- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** Provide visual console page
> Monitoring and alarm system visual console front end(angular+ts+zorro)

![hertzBeat](https://tancloud.gd2.qingstor.com/img/docs/hertzbeat-stru.svg)

## 🐕 快速开始
## 🐕 Quick start

- 如果您不想部署而是直接使用,我们提供SAAS监控云-[TanCloud探云](https://console.tancloud.cn),即刻 **[登录注册](https://console.tancloud.cn)** 免费使用。
- 如果您是想将HertzBeat部署到内网环境搭建监控系统,请参考下面的 [部署文档](https://hertzbeat.com/docs/start/quickstart) 进行操作。
- If you don't want to deploy but use it directly, we provide SAAS monitoring cloud-[TanCloud](https://console.tancloud.cn), immediately **[log in Register](https://console.tancloud.cn)** free to use.
- If you want to deploy HertzBeat to an intranet environment to build a monitoring system, please refer to the [deployment document](https://hertzbeat.com/docs/start/quickstart) below.

### 🐵 Dependent service deployment

### 🐵 依赖服务部署

> HertzBeat最少依赖于 关系型数据库[MYSQL8+](https://www.mysql.com/) 和 时序性数据库[TDengine2+](https://www.taosdata.com/getting-started)

##### 安装MYSQL
1. docker安装MYSQl
> HertzBeat at least depends on relational database [MYSQL8+](https://www.mysql.com/) and sequential database [TDengine2+](https://www.taosdata.com/getting-started)

##### Install MYSQL
1. Docker install MYSQl
`docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql`
2. 创建名称为hertzbeat的数据库
3. 执行位于项目仓库/script/sql/目录下的数据库脚本 [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql)
2. Create a database named hertzbeat
3. Execute the database script located in the scriptsql directory of the project warehouse [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql)

详细步骤参考 [依赖服务MYSQL安装初始化](https://hertzbeat.com/docs/start/mysql-init)
Detailed step reference [Dependent service MYSQL installation initialization](https://hertzbeat.com/docs/start/mysql-init)

##### 安装TDengine
1. docker安装TDengine
##### Install TDengine
1. Docker install T Dengine
`docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine`
2. 创建名称为hertzbeat的数据库
2. Create a database named hertzbeat

详细步骤参考 [依赖服务TDengine安装初始化](https://hertzbeat.com/docs/start/tdengine-init)
Detailed step reference [Dependent service TDengine installation initialization](https://hertzbeat.com/docs/start/tdengine-init)

### 🍞 HertzBeat安装
> HertzBeat支持通过源码安装启动,Docker容器运行和安装包方式安装部署。
### 🍞 HertzBeat Install
> HertzBeat supports source code installation and startup, Docker container running and installation package installation and deployment.

##### Docker方式快速安装
##### Quick installation using Docker
`docker run -d -p 1157:1157 --name hertzbeat tancloud/hertzbeat:latest`

详细步骤参考 [通过Docker方式安装HertzBeat](https://hertzbeat.com/docs/start/docker-deploy)
Detailed step reference [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy)

##### 通过安装包安装
1. 下载您系统环境对应的安装包 [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
2. 配置HertzBeat的配置文件 hertzbeat/config/application.yml
3. 部署启动 `$ ./startup.sh `
##### Install via installation package
1. Download the installation package corresponding to your system environment [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases)
2. Configure the configuration file of HertzBeat hertzbeat/config/application.yml
3. Deployment starts `$ ./startup.sh `

详细步骤参考 [通过安装包安装HertzBeat](https://hertzbeat.com/docs/start/package-deploy)
Detailed step reference [Install HertzBeat through the installation package](https://hertzbeat.com/docs/start/package-deploy)

**HAVE FUN**

## 💬 社区交流
## 💬 Community communication

HertzBeat赫兹跳动为 [Dromara开源社区](https://dromara.org/) 孵化项目
HertzBeat is [Dromara open source community](https://dromara.org/) incubation project

##### 微信交流群
##### WeChat communication group

加微信号 tan-cloud 或 扫描下面账号二维码拉您进微信群。
Add WeChat account tan-cloud or scan the account QR code below to join the WeChat group.
<img alt="tan-cloud" src="https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/docs/help/tan-cloud-wechat.jpg" width="200"/>

##### QQ交流群
##### QQ communication group

加QQ群号 236915833 或 扫描下面的群二维码进群, 验证信息: tancloud
Add QQ group number 236915833 or scan the group QR code below to join the group, verification information: tancloud

<img alt="tan-cloud" src="https://cdn.jsdelivr.net/gh/dromara/hertzbeat@gh-pages/img/docs/help/qq-qr.jpg" width="200"/>

##### 交流网站
##### Communication Website

[Dromara社区网站](https://dromara.org/)
[Dromara Community website](https://dromara.org/)

[HertzBeat用户网站](https://support.qq.com/products/379369)
[HertzBeat User website](https://support.qq.com/products/379369)

##### 仓库地址
##### Warehouse Address

[Github](https://github.com/dromara/hertzbeat) https://github.com/dromara/hertzbeat
[Gitee](https://gitee.com/dromara/hertzbeat) https://gitee.com/dromara/hertzbeat

欢迎了解使用,看到这里不妨给个Star哦,灰常感谢!
Welcome to understand and use it. If you see this, you might as well give it a star. Thank you very much!
Loading