Skip to content
Open
Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion hertzbeat-ai/src/main/resources/prompt/system-message.st
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ CRITICAL WORKFLOW Do all of this iteratively with user interaction at each step:
- Provide clear explanations of monitoring data and actionable insights

## Avoid these common errors:
- Using Label name instead of the value from the heirarchy JSON while creating alert rules.
- Using Label name instead of the value from the hierarchy JSON while creating alert rules.
- Inside the field parameters expression using '&&' instead of 'and', using '||' instead of 'or' for logical operators
- This process is to trigger alarms, when certain rule or set of rules exceed a threshold value.
So when a user says that the threshold should be less than 1000. the operator used should be '>' not '<',
Expand Down
5 changes: 3 additions & 2 deletions home/blog/2024-07-27-new-committer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,12 @@ I have been working as a Java back-end developer for three years. At present, I

## First met Apache HertzBeat

Reading code and design in open-source framework is one way for me to improve myself. One day a thought came to my mind, which is to contribute to open-source community. Then I met HertzBeat in an article on the internel, which is completely different from Prometheus and Skywalking that I had known before. HertzBeat fascinate me with its feature, agentless and anyone can custom monitoring by monifying yaml. I forked HertzBeat on GitHub and tried to run it locally for further study.
Reading code and design in open-source framework is one way for me to improve myself. One day a thought came to my mind, which is to contribute to open-source community. Then I met HertzBeat in an article on the internet, which is completely different from Prometheus and Skywalking that I had known before. HertzBeat fascinated me with its feature, agentless and anyone can custom monitoring by modifying yaml. I forked HertzBeat on GitHub and tried to run it locally for further study.

## My first PR

I failed to start HertzBeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at lease 18 is required. Therefor I modified CONTRIBUTING and opened my first PR in HertzBeat community.
I failed to start HertzBeat when I followed instructions in CONTRIBUTING. The exception shows that Node.js version at least 18 is required. Therefore I modified CONTRIBUTING and opened my first PR in HertzBeat community.


## Keep active in community

Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/docker-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed

- `docker run -d` : Run a container in the background via Docker
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/mysql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Meta Store MYSQL
---

MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.

Expand Down
4 changes: 2 additions & 2 deletions home/docs/start/postgresql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
sidebar_label: Meta Store PostgreSQL (Recommended)
---

PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you have the PostgreSQL environment, can be directly to database creation step.
> If you have a PostgreSQL environment, you can skip directly to the database creation step.

### Install PostgreSQL via Docker

Expand Down
2 changes: 1 addition & 1 deletion home/docs/start/victoria-metrics-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**

> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.

### Install VictoriaMetrics via Docker

Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.6.x/start/docker-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed

- `docker run -d` : Run a container in the background via Docker
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.6.x/start/mysql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Meta Store MYSQL
---

MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.

Expand Down
4 changes: 2 additions & 2 deletions home/versioned_docs/version-1.6.x/start/postgresql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
sidebar_label: Meta Store PostgreSQL (Recommended)
---

PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you have the PostgreSQL environment, can be directly to database creation step.
> If you have a PostgreSQL environment, you can skip directly to the database creation step.

### Install PostgreSQL via Docker

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**

> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.

### Install VictoriaMetrics via Docker

Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.7.x/start/docker-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed

- `docker run -d` : Run a container in the background via Docker
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.7.x/start/mysql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Meta Store MYSQL
---

MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.

Expand Down
4 changes: 2 additions & 2 deletions home/versioned_docs/version-1.7.x/start/postgresql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
sidebar_label: Meta Store PostgreSQL (Recommended)
---

PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you have the PostgreSQL environment, can be directly to database creation step.
> If you have a PostgreSQL environment, you can skip directly to the database creation step.

### Install PostgreSQL via Docker

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**

> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.

### Install VictoriaMetrics via Docker

Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.8.0/introduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ Built-in support for monitoring types include:

### Alarm Threshold

- Alarm Threshold are the core function of `HertzBeat`, users can configure the trigger conditions of the alarm through the threshold rules.
- Alarm Thresholds are the core function of `HertzBeat`, users can configure the trigger conditions of the alarm through the threshold rules.
- Support real-time threshold and scheduled threshold, real-time threshold can directly trigger the alarm when monitoring data is collected, scheduled threshold supports PromQL and other expressions to calculate the trigger alarm within a specified time period.
- Support visual page configuration or more flexible expression rule configuration, support configuring trigger times, alarm levels, notification templates, associated specified monitoring and so on.

Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.8.0/start/docker-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ It is necessary to have Docker environment in your environment. If not installed

- `docker run -d` : Run a container in the background via Docker
- `-p 1157:1157 -p 1158:1158` : Mapping container ports to the host, 1157 is web-ui port, 1158 is cluster port.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due creating or deleting container.
- `-v $(pwd)/data:/opt/hertzbeat/data` : (optional, data persistence) Important, Mount the H2 database file to the local host, to ensure that the data is not lost due to creating or deleting container.
- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (optional) Mount the log file to the local host to facilitate viewing.
- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (optional) Mount the configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional) Mount the account configuration file to the container (please ensure that the file exists locally). [Download](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
Expand Down
2 changes: 1 addition & 1 deletion home/versioned_docs/version-1.8.0/start/mysql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Use MYSQL Replace H2 Database to Store Metadata(Optional)
sidebar_label: Meta Store MYSQL
---

MYSQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use MYSQL to store structured relational data such as monitoring information, alarm information and configuration information.
MySQL is a reliable relational database. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use MySQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you already have a MySQL environment and the MySQL version meets the requirements, you can skip directly to the database creation step.

Expand Down
4 changes: 2 additions & 2 deletions home/versioned_docs/version-1.8.0/start/postgresql-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ title: Use PostgreSQL Replace H2 Database to Store Metadata(Recommended)
sidebar_label: Meta Store PostgreSQL (Recommended)
---

PostgreSQL is a RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allow you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.
PostgreSQL is an RDBMS emphasizing extensibility and SQL compliance. In addition to default built-in H2 database, Apache HertzBeat™ allows you to use PostgreSQL to store structured relational data such as monitoring information, alarm information and configuration information.

> If you have the PostgreSQL environment, can be directly to database creation step.
> If you have a PostgreSQL environment, you can skip directly to the database creation step.

### Install PostgreSQL via Docker

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and t
**Note⚠️ Time series database is optional, but production environment configuration is strongly recommended to provide more complete historical chart functions and high performance**
**⚠️ If you do not configure a time series database, only the last hour of historical data is retained.**

> If you already have an VictoriaMetrics environment, you can skip directly to the YML configuration step.
> If you already have a VictoriaMetrics environment, you can skip directly to the YML configuration step.

### Install VictoriaMetrics via Docker

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,16 +119,16 @@ public ResponseEntity<Message<String>> accountRegister(@RequestBody @Validated S

if (accountService.registerAccount(account)) {
Long authUser = roleService.getRoleIdByCode("role_user");
if(authUser == null) throw new HertzbeatTemplateHubException("Role query error");
if (authUser == null) throw new HertzbeatTemplateHubException("Role query error");
boolean b = accountService.authorityUserRole(account.getEmail(), authUser);
if(!b) throw new HertzbeatTemplateHubException("Role authority error");
Message<String> message=Message.success("Sign up success, login after");
if (!b) throw new HertzbeatTemplateHubException("Role authority error");
Message<String> message = Message.success("Sign up success, login after");
if (log.isDebugEnabled()) {
log.debug("account: {}, sign up success", account);
}
return ResponseEntity.ok(message);
} else {
return ResponseEntity.ok(Message.fail(FAIL_CODE,"Email already exist"));
return ResponseEntity.ok(Message.fail(FAIL_CODE, "Email already exists"));
}
}
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> Envie alarmes do Prometheus AlertManager para a plataforma de alarme HertzBeat
> Envie alarmes do Prometheus AlertManager para a plataforma de alarme HertzBeat.

### Webhook de configuração do Alertmanager

Expand Down
Loading