diff --git a/README.md b/README.md index 0de06974ae0..463423efc1b 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,13 @@ [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/apache/hertzbeat) [![zread](https://img.shields.io/badge/Ask_Zread-_.svg?style=flat&color=00b0aa&labelColor=000000&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMTYiIGhlaWdodD0iMTYiIHZpZXdCb3g9IjAgMCAxNiAxNiIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZD0iTTQuOTYxNTYgMS42MDAxSDIuMjQxNTZDMS44ODgxIDEuNjAwMSAxLjYwMTU2IDEuODg2NjQgMS42MDE1NiAyLjI0MDFWNC45NjAxQzEuNjAxNTYgNS4zMTM1NiAxLjg4ODEgNS42MDAxIDIuMjQxNTYgNS42MDAxSDQuOTYxNTZDNS4zMTUwMiA1LjYwMDEgNS42MDE1NiA1LjMxMzU2IDUuNjAxNTYgNC45NjAxVjIuMjQwMUM1LjYwMTU2IDEuODg2NjQgNS4zMTUwMiAxLjYwMDEgNC45NjE1NiAxLjYwMDFaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00Ljk2MTU2IDEwLjM5OTlIMi4yNDE1NkMxLjg4ODEgMTAuMzk5OSAxLjYwMTU2IDEwLjY4NjQgMS42MDE1NiAxMS4wMzk5VjEzLjc1OTlDMS42MDE1NiAxNC4xMTM0IDEuODg4MSAxNC4zOTk5IDIuMjQxNTYgMTQuMzk5OUg0Ljk2MTU2QzUuMzE1MDIgMTQuMzk5OSA1LjYwMTU2IDE0LjExMzQgNS42MDE1NiAxMy43NTk5VjExLjAzOTlDNS42MDE1NiAxMC42ODY0IDUuMzE1MDIgMTAuMzk5OSA0Ljk2MTU2IDEwLjM5OTlaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik0xMy43NTg0IDEuNjAwMUgxMS4wMzg0QzEwLjY4NSAxLjYwMDEgMTAuMzk4NCAxLjg4NjY0IDEwLjM5ODQgMi4yNDAxVjQuOTYwMUMxMC4zOTg0IDUuMzEzNTYgMTAuNjg1IDUuNjAwMSAxMS4wMzg0IDUuNjAwMUgxMy43NTg0QzE0LjExMTkgNS42MDAxIDE0LjM5ODQgNS4zMTM1NiAxNC4zOTg0IDQuOTYwMVYyLjI0MDFDMTQuMzk4NCAxLjg4NjY0IDE0LjExMTkgMS42MDAxIDEzLjc1ODQgMS42MDAxWiIgZmlsbD0iI2ZmZiIvPgo8cGF0aCBkPSJNNCAxMkwxMiA0TDQgMTJaIiBmaWxsPSIjZmZmIi8%2BCjxwYXRoIGQ9Ik00IDEyTDEyIDQiIHN0cm9rZT0iI2ZmZiIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIvPgo8L3N2Zz4K&logoColor=ffffff)](https://zread.ai/apache/hertzbeat) -**Home: [hertzbeat.apache.org](https://hertzbeat.apache.org)** +**Home: [hertzbeat.apache.org](https://hertzbeat.apache.org)** **Email: Mail to `dev-subscribe@hertzbeat.apache.org` to subscribe mailing lists** ## 🎡 Introduction -[Apache HertzBeat™](https://github.com/apache/hertzbeat) is an AI-powered next-generation open source real-time observability system. Unified metrics and logs collection, centralized alerting distribution, intelligent management and analysis. No Agent required, high performance cluster, provides powerful custom monitoring and status page building capabilities. +[Apache HertzBeat™](https://github.com/apache/hertzbeat) is an AI-powered next-generation open source real-time observability system. Unified metrics and logs collection, centralized alerting distribution, intelligent management and analysis. No Agent required, high performance cluster, provides powerful custom monitoring and status page building capabilities. ### Features @@ -39,17 +39,17 @@ - High performance, supports horizontal expansion of multi-collector clusters, multi-isolated network monitoring and cloud-edge collaboration. - Provides powerful status page building capabilities, easily communicate the real-time status of your service to users. -> HertzBeat's unified platform, AI intelligence, powerful customization, multi-type support, high performance, and easy expansion, aims to help users quickly and conveniently achieve observability requirements. +> HertzBeat's unified platform, AI intelligence, powerful customization, multi-type support, high performance, and easy expansion, aims to help users quickly and conveniently achieve observability requirements. ---- ---- -## 🥐 Architecture +## 🥐 Architecture ![HertzBeat](home/static/img/docs/hertzbeat-arch.png) -## ⛄ Supported +## ⛄ Supported > We define all metrics collection types such as `mysql`, `jvm`, and `k8s` as `YML` templates, allowing users to import them to support corresponding types of monitoring. > Welcome everyone to contribute your customized general metrics type YML template during use. @@ -95,15 +95,15 @@ - Notified Support `Discord` `Slack` `Telegram` `Email` `Dingtalk` `WeChat` `FeiShu` `Webhook` `SMS` `ServerChan`. -## 🐕 Quick Start +## 🐕 Quick Start - If you wish to deploy HertzBeat locally, please refer to the following Deployment Documentation for instructions. -### 🍞 Install HertzBeat +### 🍞 Install HertzBeat -> HertzBeat supports installation through source code, docker or package, cpu support x86/arm64. +> HertzBeat supports installation through source code, docker or package, cpu support x86/arm64. -##### 1：Install quickly via docker +##### 1：Install quickly via docker 1. Just one command to get started @@ -111,7 +111,7 @@ docker run -d -p 1157:1157 -p 1158:1158 --name hertzbeat apache/hertzbeat ``` -2. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` +2. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` 3. Deploy collector clusters (Optional) @@ -125,14 +125,14 @@ - `-e MANAGER_PORT=1158` : set the main hertzbeat server port, default 1158. -Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache.org/docs/start/docker-deploy) +Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache.org/docs/start/docker-deploy) -##### 2：Install via package +##### 2：Install via package 1. Download the release package `apache-hertzbeat-xx-bin.tar.gz` [Download](https://hertzbeat.apache.org/docs/download) -2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) -3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` -4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` +2. Configure the HertzBeat configuration yml file `hertzbeat/config/application.yml` (optional) +3. Run command `$ ./bin/startup.sh ` or `bin/startup.bat` +4. Access `http://localhost:1157` to start, default account: `admin/hertzbeat` 5. Deploy collector clusters (Optional) - Download the release package `apache-hertzbeat-collector-xx-bin.tar.gz` (JVM collector) or the native collector package for your platform, such as `apache-hertzbeat-collector-native-xx-linux-amd64-bin.tar.gz` or `apache-hertzbeat-collector-native-xx-windows-amd64-bin.zip`, to the new machine [Download](https://hertzbeat.apache.org/docs/download) - Configure the collector configuration yml file `hertzbeat-collector/config/application.yml`: unique `identity` name, running `mode` (public or private), hertzbeat `manager-host`, hertzbeat `manager-port` @@ -150,24 +150,24 @@ Detailed config refer to [Install HertzBeat via Docker](https://hertzbeat.apache - If you do not provide JDBC drivers in `ext-lib`, MySQL, MariaDB, and OceanBase can use the built-in query engine and run on the native collector package as well. TiDB follows the same rule for its SQL query metric set. - If `mysql-connector-j` is present in `ext-lib`, the built-in server collector or JVM collector automatically prefers JDBC after restart for MySQL, MariaDB, and OceanBase. TiDB follows the same rule for its SQL query metric set, while its HTTP metrics are unchanged. Oracle and DB2 still require the JVM collector package because they depend on external JDBC drivers. - Run `$ ./bin/startup.sh ` or `bin/startup.bat` for the JVM collector package. Run `$ ./bin/startup.sh ` for Linux or macOS native collector packages, and `bin\\startup.bat` for the Windows native collector package. - - Access `http://localhost:1157` and you will see the registered new collector in dashboard + - Access `http://localhost:1157` and you will see the registered new collector in dashboard -Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apache.org/docs/start/package-deploy) +Detailed config refer to [Install HertzBeat via Package](https://hertzbeat.apache.org/docs/start/package-deploy) -##### 3：Start via source code +##### 3：Start via source code -1. Local source code debugging needs to start the back-end project `hertzbeat-startup` and the front-end project `web-app`. +1. Local source code debugging needs to start the back-end project `hertzbeat-startup` and the front-end project `web-app`. 2. Backend：need `maven3+`, `java25`, `lombok`, add VM options in IDE: ` --add-opens=java.base/java.nio=org.apache.arrow.memory.core,ALL-UNNAMED `, then start the `hertzbeat-startup` service. -3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. -4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` +3. Web：need `nodejs npm angular-cli` environment, Run `ng serve --open` in `web-app` directory after backend startup. +4. Access `http://localhost:4200` to start, default account: `admin/hertzbeat` -Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md) +Detailed steps refer to [CONTRIBUTING](CONTRIBUTING.md) -##### 4：Install All(hertzbeat+postgresql+tsdb) via Docker-compose +##### 4：Install All(hertzbeat+postgresql+tsdb) via Docker-compose Install the postgresql/mysql database, victoria-metrics/iotdb/tdengine database and hertzbeat at one time through [docker-compose deployment script](script/docker-compose). -Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md) +Detailed steps refer to [Install via Docker-Compose](script/docker-compose/README.md) ##### 5: Install All(hertzbeat+collector+postgresql+tsdb) via kubernetes helm charts @@ -179,8 +179,8 @@ Detailed steps refer to [Artifact Hub](https://artifacthub.io/packages/helm/hert ## ✨ Contributors -Thanks to these wonderful people, welcome to join us: -[Contributor Guide](CONTRIBUTING.md) +Thanks to these wonderful people, welcome to join us: +[Contributor Guide](CONTRIBUTING.md) @@ -558,7 +558,7 @@ Thanks to these wonderful people, welcome to join us: - + ## 💬 Join discussion @@ -570,7 +570,7 @@ Thanks to these wonderful people, welcome to join us: WeChat Group : Add friend `ahertzbeat` and invite to the group. -WeChat Public : Search ID `usthecom`. +WeChat Official Account : Search ID `usthecom`. [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/blog/2024-07-07-new-committer.md b/home/blog/2024-07-07-new-committer.md index 4238af94793..572911db836 100644 --- a/home/blog/2024-07-07-new-committer.md +++ b/home/blog/2024-07-07-new-committer.md @@ -17,7 +17,7 @@ I have always been passionate about the open-source community, and I am also a C ## My Connection with HertzBeat -In April of this year, when HertzBeat entered the Apache Incubator, I happened to see a recommendation on a WeChat public account in my social circle. +In April of this year, when HertzBeat entered the Apache Incubator, I happened to see a recommendation on a WeChat Official Account in my social circle. My first reaction was that the name was really well chosen 😄. Then, after looking closely at the features it provides and the problems it solves, I realized its powerful functionalities 💪. diff --git a/home/docs/community/contact.md b/home/docs/community/contact.md index e3c6720bfef..3132912bed8 100644 --- a/home/docs/community/contact.md +++ b/home/docs/community/contact.md @@ -1,6 +1,6 @@ --- -id: contact -title: Join discussion +id: contact +title: Join discussion sidebar_label: Discussion --- @@ -12,7 +12,7 @@ sidebar_label: Discussion WeChat Group : Add friend `ahertzbeat` and invite to the group. -WeChat Public : Search ID `usthecom`. +WeChat Official Account : Search ID `usthecom`. [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/versioned_docs/version-1.6.x/community/contact.md b/home/versioned_docs/version-1.6.x/community/contact.md index e3c6720bfef..3132912bed8 100644 --- a/home/versioned_docs/version-1.6.x/community/contact.md +++ b/home/versioned_docs/version-1.6.x/community/contact.md @@ -1,6 +1,6 @@ --- -id: contact -title: Join discussion +id: contact +title: Join discussion sidebar_label: Discussion --- @@ -12,7 +12,7 @@ sidebar_label: Discussion WeChat Group : Add friend `ahertzbeat` and invite to the group. -WeChat Public : Search ID `usthecom`. +WeChat Official Account : Search ID `usthecom`. [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/versioned_docs/version-1.7.x/community/contact.md b/home/versioned_docs/version-1.7.x/community/contact.md index e3c6720bfef..3132912bed8 100644 --- a/home/versioned_docs/version-1.7.x/community/contact.md +++ b/home/versioned_docs/version-1.7.x/community/contact.md @@ -1,6 +1,6 @@ --- -id: contact -title: Join discussion +id: contact +title: Join discussion sidebar_label: Discussion --- @@ -12,7 +12,7 @@ sidebar_label: Discussion WeChat Group : Add friend `ahertzbeat` and invite to the group. -WeChat Public : Search ID `usthecom`. +WeChat Official Account : Search ID `usthecom`. [Github Discussion](https://github.com/apache/hertzbeat/discussions) diff --git a/home/versioned_docs/version-1.8.0/community/contact.md b/home/versioned_docs/version-1.8.0/community/contact.md index e3c6720bfef..3132912bed8 100644 --- a/home/versioned_docs/version-1.8.0/community/contact.md +++ b/home/versioned_docs/version-1.8.0/community/contact.md @@ -1,6 +1,6 @@ --- -id: contact -title: Join discussion +id: contact +title: Join discussion sidebar_label: Discussion --- @@ -12,7 +12,7 @@ sidebar_label: Discussion WeChat Group : Add friend `ahertzbeat` and invite to the group. -WeChat Public : Search ID `usthecom`. +WeChat Official Account : Search ID `usthecom`. [Github Discussion](https://github.com/apache/hertzbeat/discussions)