From 69af6d2a12802839576cc02ed5dfd9c90149c0c6 Mon Sep 17 00:00:00 2001 From: tomsun28 Date: Sun, 10 Apr 2022 17:14:05 +0800 Subject: [PATCH] [docs]support en docs --- README.md | 2 +- README_EN.md | 148 +++++++++++++++++++++ home/static/img/docs/hertzbeat-stru-en.svg | 1 + 3 files changed, 150 insertions(+), 1 deletion(-) create mode 100644 README_EN.md create mode 100644 home/static/img/docs/hertzbeat-stru-en.svg diff --git a/README.md b/README.md index 10cc69a..6a98533 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [comment]: <> (sureness) -## HertzBeat 赫兹跳动 +## HertzBeat 赫兹跳动 | [English Documentation](README_EN.md) > 易用友好的监控告警系统。 diff --git a/README_EN.md b/README_EN.md new file mode 100644 index 0000000..7058ad2 --- /dev/null +++ b/README_EN.md @@ -0,0 +1,148 @@ +

+ + hertzbeat + +

+ +[comment]: <> (sureness) + +## HertzBeat | [中文文档](README.md) + +> Friendly cloud monitoring system. + +![tan-cloud](https://img.shields.io/badge/web-monitor-4EB1BA) +![tan-cloud](https://img.shields.io/badge/api-monitor-lightgrey) +![tan-cloud](https://img.shields.io/badge/ping-connect-brightgreen) +![tan-cloud](https://img.shields.io/badge/port-available-green) +![tan-cloud](https://img.shields.io/badge/database-monitor-yellowgreen) +![tan-cloud](https://img.shields.io/badge/os-monitor-yellow) +![tan-cloud](https://img.shields.io/badge/custom-monitor-orange) +![tan-cloud](https://img.shields.io/badge/threshold-red) +![tan-cloud](https://img.shields.io/badge/alert-bule) + +**Home: [hertzbeat.com](https://hertzbeat.com) | [tancloud.cn](https://tancloud.cn)** + +## 🎡 Introduction + +> [HertzBeat](https://github.com/dromara/hertzbeat) is an opensource monitoring and alarm project incubated by [Dromara](https://dromara.org) and open sourced by [TanCloud](https://tancloud.cn), which supports Website, API, PING, Port, Database, OS Monitor etc. +> We also provide **[Monitoring Cloud For Saas](https://console.tancloud.cn)**, people no longer need to deploy a cumbersome monitoring system in order to monitor their website resources. **[Sign in to get started for free](https://console.tancloud.cn)**. +> HertzBeat supports more liberal threshold alarm configuration (calculation expression), supports alarm notification, alarm template, email, DingDing, WeChat FeiShu and WebHook. +> Most important is HertzBeat supports [Custom Monitoring](https://hertzbeat.com/docs/advanced/extend-point), just by configuring the YML file, we can customize the monitoring types and metrics what we need. +> HertzBeat is modular, `manager, collector, scheduler, warehouse, alerter` modules are decoupled for easy understanding and custom development. +> Welcome to HertzBeat's [Cloud Environment TanCloud](https://console.tancloud.cn) to try and discover more. +> Welcome to join us to build hertzbeat together. + +> `HertzBeat`'s multi-type support, easy expansion, low coupling, hope to help developers and micro teams to quickly build their own monitoring system. + +---- + +[![tancloud](tancloud.gif)](https://www.bilibili.com/video/BV1DY4y1i7ts) + +---- + +## 🥐 Architecture + +- **[manager](https://github.com/dromara/hertzbeat/tree/master/manager)** Provide monitoring management, system management basic services. +> Provides monitoring management, monitoring configuration management, system user management, etc. +- **[collector](https://github.com/dromara/hertzbeat/tree/master/collector)** Provide metrics data collection services. +> Use common protocols to remotely collect and obtain peer-to-peer metrics data. +- **[scheduler](https://github.com/dromara/hertzbeat/tree/master/scheduler)** Provide monitoring task scheduling service. +> Collection task management, scheduling and distribution of one-time tasks and periodic tasks. +- **[warehouse](https://github.com/dromara/hertzbeat/tree/master/warehouse)** Provide monitoring data warehousing services. +> Metrics data management, data query, calculation and statistics. +- **[alerter](https://github.com/dromara/hertzbeat/tree/master/alerter)** Provide alert service. +> Alarm calculation trigger, monitoring status linkage, alarm configuration, and alarm notification. +- **[web-app](https://github.com/dromara/hertzbeat/tree/master/web-app)** Provide web ui. +> Angular Web UI. + +![hertzBeat](home/static/img/docs/hertzbeat-stru-en.svg) + + +## 🐕 Quick Start + +- If you don’t want to deploy but use it directly, we provide [SAAS Monitoring Cloud-TanCloud](https://console.tancloud.cn), **[Log In And Register For Free](https://console.tancloud.cn) **. +- If you want to deploy HertzBeat local, please refer to the following [Deployment Documentation](https://hertzbeat.com/docs/start/quickstart) for operation. + +### 🐵 Dependency Service Deployment + +> HertzBeat depends at least on relational database [MYSQL5+](https://www.mysql.com/) and time series database [TDengine2+](https://www.taosdata.com/getting-started) + +##### Install MYSQL +1. Install mysql with docker + `docker run -d --name mysql -p 3306:3306 -e MYSQL_ROOT_PASSWORD=123456 mysql:5.7` +2. Create database names `hertzbeat` +3. Run the database sql script [schema.sql](https://gitee.com/dromara/hertzbeat/raw/master/script/sql/schema.sql) located in the project repository `/script/sql/` directory. + +For detailed steps, refer to [MYSQL Installation And Initialization](https://hertzbeat.com/docs/start/mysql-init) + +##### Install TDengine +1. Install TDengine with docker + `docker run -d -p 6030-6049:6030-6049 -p 6030-6049:6030-6049/udp --name tdengine tdengine/tdengine:2.4.0.12` +2. Create database names `hertzbeat` + +For detailed steps, refer to [TDengine Installation And Initialization](https://hertzbeat.com/docs/start/tdengine-init). + +### 🍞 Install HertzBeat + +> HertzBeat supports installation through source code, docker or package. + +##### 1：Install quickly via docker +`docker run -d -p 1157:1157 -v /opt/application.yml:/opt/hertzbeat/config/application.yml --name hertzbeat tancloud/hertzbeat:[版本tag]` + +Detailed steps refer to [Install HertzBeat via Docker](https://hertzbeat.com/docs/start/docker-deploy) + +##### 2：Install via package +1. Download the installation package [GITEE Release](https://gitee.com/dromara/hertzbeat/releases) [GITHUB Release](https://github.com/dromara/hertzbeat/releases) +2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` +3. Run shell `$ ./startup.sh ` +4. Access `localhost:1157` to start, default account: `admin/admin` + +Detailed steps refer to [Install HertzBeat via package](https://hertzbeat.com/docs/start/package-deploy) + +##### 3：Start via source code +1. Local source code debugging needs to start the back-end project manager and the front-end project web-app. +2. Backend：need `maven3+`, `java8+`, start the manager service. +3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. +4. Access `localhost:4200` to start, default account: `admin/admin` + +Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md) + +##### 4：Install All(mysql+tdengine+hertzbeat) via Docker-compose + +Install and deploy the mysql database, tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose). + +Detailed steps refer to [docker-compose install](script/docker-compose/README.md) + +**HAVE FUN** + +## 💬 Join discussion + +HertzBeat is an incubation project of [Dromara Open Source Community](https://dromara.org/). + +##### WeChat Group + +Add WeChat account `tan-cloud` or scan the QR code below to pull you into the WeChat group. + +tan-cloud + +##### QQ Group + +QQ group number `718618151` or scan the group QR code below, verify code: `tancloud` + +tan-cloud + +##### Github Discussion + +Welcome to Discuss in [Github Discussion](https://github.com/dromara/hertzbeat/discussions) + +##### Public WeChat + +tan-cloud + +##### Sponsor + +Thanks [吉实信息(构建全新的微波+光交易网络)](https://www.flarespeed.com) sponsored server node. +Thanks [天上云计算(全新智慧上云)](https://www.tsyvps.com/aff/BZBEGYLX) sponsored server node. + +## 🛡️ License +[`Apache License, Version 2.0`](https://www.apache.org/licenses/LICENSE-2.0.html) diff --git a/home/static/img/docs/hertzbeat-stru-en.svg b/home/static/img/docs/hertzbeat-stru-en.svg new file mode 100644 index 0000000..a9855f8 --- /dev/null +++ b/home/static/img/docs/hertzbeat-stru-en.svg @@ -0,0 +1 @@ +Angularwebappmanagerschedulermanager collect jobSchedule JobscollectorhttpsqlsshtelnetsdkWebDatabaseApp ServiceMiddlewareOSqueuepush metrics datawarehousepullTdEngine/InfluxdbMemory/RedisHistory dataReal-time datamysqlmonitor,system dataalertpullMonitor，User，System APIAlarm trigger and notify.Alert APIMetrics Data APIalert dataDefault，jsonPath，prometheusParse \ No newline at end of file