This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch doc112
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/doc112 by this push:
new 2d2655896 [doc] update deploy guide
2d2655896 is described below
commit 2d2655896adbdc32f3e231250683c407af634d58
Author: tomsun28 <[email protected]>
AuthorDate: Mon Jul 22 19:10:24 2024 +0800
[doc] update deploy guide
---
home/docs/help/mariadb.md | 6 +
home/docs/help/mysql.md | 3 +-
home/docs/help/oracle.md | 6 +
home/docs/start/docker-compose-deploy.md | 67 ++++++++
home/docs/start/docker-deploy.md | 174 ++++++++++---------
home/docs/start/package-deploy.md | 125 +++++++++-----
.../en/docusaurus-plugin-content-docs/current.json | 21 ++-
.../{current.json => version-v1.5.x.json} | 155 ++++++++---------
.../docusaurus-plugin-content-docs/current.json | 22 ++-
.../current/help/mariadb.md | 6 +
.../current/help/mysql.md | 3 +-
.../current/help/oracle.md | 6 +
.../current/start/docker-compose-deploy.md | 69 ++++++++
.../current/start/docker-deploy.md | 191 +++++++++------------
.../current/start/package-deploy.md | 137 +++++++++------
.../current/start/sslcert-practice.md | 2 +-
.../version-v1.5.x.json} | 155 ++++++++---------
home/sidebars.json | 70 ++++++--
.../version-v1.4.x-sidebars.json | 1 -
19 files changed, 749 insertions(+), 470 deletions(-)
diff --git a/home/docs/help/mariadb.md b/home/docs/help/mariadb.md
index e72668fe7..6738a2710 100644
--- a/home/docs/help/mariadb.md
+++ b/home/docs/help/mariadb.md
@@ -7,6 +7,12 @@ keywords: [open source monitoring tool, open source database
monitoring tool, mo
> Collect and monitor the general performance Metrics of MariaDB database.
> Support MariaDB5+.
+### Attention, Need Add MYSQL jdbc driver jar
+
+- Download the MYSQL jdbc driver jar package, such as
mysql-connector-java-8.1.0.jar.
https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0
+- Copy the jar package to the `hertzbeat/ext-lib` directory.
+- Restart the HertzBeat service.
+
### Configuration parameter
| Parameter name | Parameter help description |
diff --git a/home/docs/help/mysql.md b/home/docs/help/mysql.md
index 44e00ede3..4ec232ee8 100644
--- a/home/docs/help/mysql.md
+++ b/home/docs/help/mysql.md
@@ -7,10 +7,11 @@ keywords: [open source monitoring tool, open source database
monitoring tool, mo
> Collect and monitor the general performance Metrics of MySQL database.
> Support MYSQL5+.
-### Add MYSQL jdbc driver jar
+### Attention, Need Add MYSQL jdbc driver jar
- Download the MYSQL jdbc driver jar package, such as
mysql-connector-java-8.1.0.jar.
https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0
- Copy the jar package to the `hertzbeat/ext-lib` directory.
+- Restart the HertzBeat service.
### Configuration parameter
diff --git a/home/docs/help/oracle.md b/home/docs/help/oracle.md
index 5410e53de..08e59eb06 100644
--- a/home/docs/help/oracle.md
+++ b/home/docs/help/oracle.md
@@ -7,6 +7,12 @@ keywords: [open source monitoring tool, open source database
monitoring tool, mo
> Collect and monitor the general performance Metrics of ORACLE database.
+### Attention, Need Add ORACLE jdbc driver jar
+
+- Download the ORACLE jdbc driver jar package, such as ojdbc8.jar.
[Download](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar)
[oracle-i18n](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar)
+- Copy the jar package to the `hertzbeat/ext-lib` directory.
+- Restart the HertzBeat service.
+
### Configuration parameter
| Parameter name | Parameter help description
|
diff --git a/home/docs/start/docker-compose-deploy.md
b/home/docs/start/docker-compose-deploy.md
new file mode 100644
index 000000000..0dd6fe054
--- /dev/null
+++ b/home/docs/start/docker-compose-deploy.md
@@ -0,0 +1,67 @@
+---
+id: docker-compose-deploy
+title: Install HertzBeat via Docker Compose
+sidebar_label: Install via Docker Compose
+---
+
+:::tip
+Suggest to use Docker Compose to deploy HertzBeat and its dependent services.
+:::
+
+:::note
+This document assumes that you already have Docker and Docker Compose
installed in your environment. If not, please refer to the [Docker official
documentation](https://docs.docker.com/compose/install/).
+Run the `docker compose version` command to check if you have a Docker Compose
environment.
+:::
+
+1. Download the startup script package
+
+Download the installation script package
`apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` from the
[download](https://github.com/apache/hertzbeat/releases/download/v1.6.0/apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz)
+
+2. Choose to use the HertzBeat + PostgreSQL + VictoriaMetrics solution
+
+:::tip
+- `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` contains multiple
deployment solutions after decompression. Here we recommend choosing the
`hertzbeat-postgresql-victoria-metrics` solution.
+- Other deployment methods, please read the README.md file of each deployment
solution in detail. The MySQL solution requires you to prepare the MySQL driver
package yourself.
+:::
+
+- Unzip the script package
+
+```
+$ tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
+```
+
+- Enter the decompression directory and select `HertzBeat + PostgreSQL +
VictoriaMetrics` for one-click deployment
+
+```
+$ cd apache-hertzbeat-1.6.0-incubating-docker-compose
+$ cd hertzbeat-postgresql-victoria-metrics
+```
+
+- One-click start
+
+> Run script in `hertzbeat-postgresql-victoria-metrics` directory
+
+```
+docker-compose up -d
+```
+
+- View service status
+
+> View the running status of each container, up is the normal running status
+
+```
+docker-compose ps
+```
+
+4. Start exploring HertzBeat
+ Access http://ip:1157/ in the browser to start exploring and using it. The
default account password is admin/hertzbeat.
+
+**HAVE FUN**
+
+
+----
+
+### FAQ
+
+**The most common problem is network problems, please check in advance**
+
diff --git a/home/docs/start/docker-deploy.md b/home/docs/start/docker-deploy.md
index db0da790b..8222c6d0c 100644
--- a/home/docs/start/docker-deploy.md
+++ b/home/docs/start/docker-deploy.md
@@ -4,83 +4,64 @@ title: Install HertzBeat via Docker
sidebar_label: Install via Docker
---
-> Recommend to use docker deploy Apache HertzBeat (incubating)
-
-
-1. Download and install the Docker environment
- Docker tools download refer to [Docker official
document](https://docs.docker.com/get-docker/)。
- After the installation you can check if the Docker version normally output
at the terminal.
- ```
- $ docker -v
- Docker version 20.10.12, build e91ed57
- ```
-
-2. pull HertzBeat Docker mirror
- you can look up the mirror version TAG in [dockerhub mirror
repository](https://hub.docker.com/r/apache/hertzbeat/tags)
- or in [quay.io mirror
repository](https://quay.io/repository/tancloud/hertzbeat)
- ```shell
- $ docker pull apache/hertzbeat
- $ docker pull apache/hertzbeat-collector
- ```
- or
- ```shell
- $ docker pull quay.io/tancloud/hertzbeat
- $ docker pull quay.io/tancloud/hertzbeat-collector
- ```
-
-3. Mounted HertzBeat configuration file (optional)
- Mounted and config `application.yml` in the host directory,
eg:`$(pwd)/application.yml`
- ```-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml````
- Download from
[github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- You can modify the configuration yml file according to your needs.
- - If you need to use email to send alarms, you need to replace the email
server parameters `spring.mail` in `application.yml`
- - **Recommended** If you need to use an external Mysql database to replace
the built-in H2 database, you need to replace the `spring.datasource` parameter
in `application.yml` For specific steps, see [Using Mysql to replace H2
database](mysql-change)
- - **Recommended** If you need to use the time series database
victoria-metrics to store metric data, you need to replace the
`warehouse.store.victoria-metrics` parameter in `application.yml` for specific
steps, see [Using victoria-metrics to store metrics
data](victoria-metrics-init)
-
-4. Mounted the account file(optional)
- HertzBeat default built-in three user accounts, respectively
`admin/hertzbeat tom/hertzbeat guest/hertzbeat`
- If you need update account or password, configure `sureness.yml`. Ignore
this step without this demand.
- Download and config `sureness.yml` in the host
directory，eg:`$(pwd)/sureness.yml`
- Download from
[github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
- For detail steps, please refer to [Configure Account
Password](account-modify)
-
-5. Start the HertzBeat Docker container
+:::tip
+Using Docker to start HertzBeat with the minimum available environment, no
external service dependencies, easy to experience quickly.
+But it is not recommended to use in production environment, it is recommended
to use Docker Compose deployment, installation package deployment, Kubernetes
deployment in production environment.
+:::
+
+:::note
+It is necessary to have Docker environment in your environment. If not
installed, please refer to [Docker official
document](https://docs.docker.com/get-docker/)
+:::
+
+### Deploy HertzBeat Server
+
+1. Execute the following command
```shell
$ docker run -d -p 1157:1157 -p 1158:1158 \
- -e LANG=en_US.UTF-8 \
- -e TZ=Asia/Shanghai \
-v $(pwd)/data:/opt/hertzbeat/data \
-v $(pwd)/logs:/opt/hertzbeat/logs \
-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \
-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml \
+ --restart=always \
--name hertzbeat apache/hertzbeat
```
- This command starts a running HertzBeat Docker container with mapping port
1157-1158. If existing processes on the host use the port, please modify host
mapped port.
- - `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.
- - `-e LANG=en_US.UTF-8` : Set the system language
- - `-e TZ=Asia/Shanghai` : Set the system timezone
- - `-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)/logs:/opt/hertzbeat/logs` : (optional, if you don't have a
need, just delete it) Mount the log file to the local host, to ensure the log
will not be lost due creating or deleting container.
- - `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` :
(optional, if you don't have a need, just delete it) Mount the local
configuration file into the container which has been modified in the previous
step, namely using the local configuration file to cover container
configuration file.
- - `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (optional,
if you don't have a need, just delete it) Mount account configuration file
modified in the previous step into the container. Delete this command
parameters if no needs.
- - `-v $(pwd)/ext-lib:/opt/hertzbeat/ext-lib` : (optional, if you don't
have a need, just delete it)Copy the driver jar to the corresponding directory
of the host and mount it to the ext-lib directory according to the database
connection such as mysql/oracle that you have downloaded
-
mysql:https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip
-
oracle:https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar
https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar
- - `There is also a way to customize the data source connection driver
without mounting`(optional)This approach is to put the data source drivers you
need directly inside the container
- - `docker cp $(pwd)/mysql-connector-java-8.0.18.jar
hertzbeat:/opt/hertzbeat/ext-lib` Use the docker cp command to first download
the data source driver cp into the container
- - `docker restart hertzbeat` After the restart is successful, it can be
used normally
- - `docker commit -a "operator" -m "New custom data source drivers in the
/ext-lib folder inside the container" hertzbeat hertzbeat:version`(optional, if
you don't have a need, just delete it) If you want to create a custom image by
yourself, run this command. -a The current operator -m describes the container
that you have recreated
- - `--name hertzbeat` : Naming container name hertzbeat
- - `apache/hertzbeat` : Use the pulled latest HertzBeat official application
mirror to start the container. **Use `quay.io/tancloud/hertzbeat` instead if
you pull `quay.io` docker image.**
-
-6. Begin to explore HertzBeat
-
- Access `http://ip:1157/` using browser. You can explore HertzBeat with
default account `admin/hertzbeat` now!
-
-7. Deploy collector cluster (Optional)
+> Command parameter explanation
+
+- `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)/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)
+- `-v $(pwd)/ext-lib:/opt/hertzbeat/ext-lib` : (optional) Mount external
third-party JAR package
[mysql-jdbc](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip)
[oracle-jdbc](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar)
[oracle-i18n](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar)
+- `--name hertzbeat` : (optional) Naming container name hertzbeat
+- `--restart=always` : (optional) Configure the container to restart
automatically.
+- `apache/hertzbeat` : Use the [official application
mirror](https://hub.docker.com/r/apache/hertzbeat) to start the container, if
the network times out, use `quay.io/tancloud/hertzbeat` instead.
+- `--network host` : (optional) Use the host network mode to start Docker,
namely making Docker container and hosting share network. `docker run -d
--network host .....`
+
+:::tip
+- Marked as optional parameters, non-mandatory items, if not needed, delete
them.
+- This maps the 1157,1158 ports of the container to the 1157,1158 ports of the
host. If the port on the host is already occupied, you need to modify the host
mapping port.
+- When mounting files, the first parameter is your custom local file address,
and the second parameter is the container file address. Make sure you have this
file locally when mounting.
+- You can execute `docker update --restart=always hertzbeat` to configure the
container to restart automatically.
+- If you want to use the host network mode to start Docker, you can use
`docker run -d --network host .....`
+:::
+
+2. Start to explore HertzBeat
+ Access http://ip:1157/ using browser. You can explore HertzBeat with
default account `admin/hertzbeat` now!
+
+### Deploy HertzBeat Collector Cluster(Optional)
+
+:::note
+HertzBeat Collector is a lightweight data collector used to collect and send
data to HertzBeat Server.
+By deploying multiple HertzBeat Collectors, high availability, load balancing,
and cloud-edge collaboration of data can be achieved.
+:::
+
+
+
+1. Execute the following command
```shell
$ docker run -d \
@@ -91,36 +72,48 @@ $ docker run -d \
--name hertzbeat-collector apache/hertzbeat-collector
```
- This command starts a running HertzBeat-Collector container.
- - `docker run -d` : Run a container in the background via Docker
- - `-e IDENTITY=custom-collector-name` : (optional) Set the collector
unique identity name. Attention the clusters collector name must unique.
- - `-e MODE=public` : set the running mode(public or private), public
cluster or private cloud-edge.
- - `-e MANAGER_HOST=127.0.0.1` : Important⚠️ Set the main hertzbeat server
ip.
- - `-e MANAGER_PORT=1158` : (optional) Set the main hertzbeat server port,
default 1158.
- - `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (optional) Mount the log
file to the local host, to ensure the log will not be lost due creating or
deleting container.
- - `--name hertzbeat-collector` : Naming container name hertzbeat-collector
- - `apache/hertzbeat-collector` : Use the pulled latest HertzBeat-Collector
official application mirror to start the container. **Use
`quay.io/tancloud/hertzbeat-collector` instead if you pull `quay.io` docker
image.**
+> Command parameter explanation
+
+- `docker run -d` : Run a container in the background via Docker
+- `-e IDENTITY=custom-collector-name` : (optional) Set the collector unique
identity name. Attention the clusters collector name must unique.
+- `-e MODE=public` : set the running mode(public or private), public cluster
or private
+- `-e MANAGER_HOST=127.0.0.1` : Important, Set the main hertzbeat server ip
host, must use the server host instead of 127.0.0.1.
+- `-e MANAGER_PORT=1158` : (optional) Set the main hertzbeat server port,
default 1158.
+- `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (optional) Mount the log
file to the local host to facilitate viewing.
+- `--name hertzbeat-collector` : Naming container name hertzbeat-collector
+- `apache/hertzbeat-collector` : Use the [official application
mirror](https://hub.docker.com/r/apache/hertzbeat-collector) to start the
container, if the network times out, use `quay.io/tancloud/hertzbeat-collector`
instead.
+- `--network host` : (optional) Use the host network mode to start Docker,
namely making Docker container and hosting share network. `docker run -d
--network host .....`
+
+:::tip
+- Marked as optional parameters, non-mandatory items, if not needed, delete
them.
+- The `127.0.0.1` in `MANAGER_HOST` needs to be replaced with the external IP
address of the HertzBeat Server.
+- When mounting files, the first parameter is your custom local file address,
and the second parameter is the container file address. Make sure you have this
file locally when mounting.
+- You can execute `docker update --restart=always hertzbeat-collector` to
configure the container to restart automatically.
+- If you want to use the host network mode to start Docker, you can use
`docker run -d --network host .....`
+:::
+
+2. Access `http://localhost:1157` and you will see the registered new
collector in dashboard.
-8. Access `http://localhost:1157` and you will see the registered new
collector in dashboard.
+**HAVE FUN**
-**HAVE FUN**
+----
### FAQ
**The most common problem is network problems, please check in advance**
-1. **MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by
Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail**
+1. MYSQL, TDENGINE, IoTDB and HertzBeat are deployed on the same host by
Docker,HertzBeat use localhost or 127.0.0.1 connect to the database but fail
The problems lies in Docker container failed to visit and connect localhost
port. Because the docker default network mode is Bridge mode which can't access
local machine through localhost.
> Solution A：Configure application.yml. Change database connection address
> from localhost to external IP of the host machine.
> Solution B：Use the Host network mode to start Docker, namely making Docker
> container and hosting share network. `docker run -d --network host .....`
-2. **According to the process deploy，visit http://ip:1157/ no interface**
+2. According to the process deploy，visit http://ip:1157/ no interface
Please refer to the following points to troubleshoot issues：
> 1：If you switch to dependency service MYSQL database，check whether the
> database is created and started successfully.
> 2：Check whether dependent services, IP account and password configuration is
> correct in HertzBeat's configuration file `application.yml`.
> 3：`docker logs hertzbeat` Check whether the container log has errors. If you
> haven't solved the issue, report it to the communication group or community.
-3. **Historical monitoring charts have been missing data for a long time**
+3. Historical monitoring charts have been missing data for a long time
> 1：Check whether you configure victoria-metrics or Tdengine or IoTDB. No
> configuration means no historical chart data.
> 2: Check whether IP account and password configuration is correct in
> HertzBeat's configuration file `application.yml`.
@@ -133,3 +126,22 @@ Please refer to the following points to troubleshoot
issues：
> Is time-series database enable set to true
> Note⚠️If both hertzbeat and time-series database are started under the same
> host for docker containers, 127.0.0.1 cannot be used for communication
> between containers by default, and the host IP is changed
> You can check the startup logs according to the logs directory
+
+6. What is the purpose of application.yml
+
+> This file is the configuration file of HertzBeat, used to configure various
parameters of HertzBeat, such as database connection information, time series
database configuration, etc.
+> Download `application.yml` file to the host directory, for example:
$(pwd)/application.yml
+> Download source
[github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
+You can modify the configuration yml file according to your needs.
+- If you need to use email to send alarms, you need to replace the email
server parameters `spring.mail` in `application.yml`
+- **Recommended** If you need to use an external Mysql database to replace the
built-in H2 database, you need to replace the `spring.datasource` parameter in
`application.yml` For specific steps, see [Using Mysql to replace H2
database](mysql-change)
+- **Recommended** If you need to use the time series database victoria-metrics
to store metric data, you need to replace the
`warehouse.store.victoria-metrics` parameter in `application.yml` for specific
steps, see [Using victoria-metrics to store metrics
data](victoria-metrics-init)
+
+7. What is the purpose of sureness.yml
+
+> This file is the user configuration file of HertzBeat, used to configure
user information of HertzBeat, such as account password, etc.
+> HertzBeat default built-in three user accounts, respectively
`admin/hertzbeat tom/hertzbeat guest/hertzbeat`
+> If you need update account or password, configure `sureness.yml`. Ignore
this step without this demand.
+> Download and config `sureness.yml` in the host
directory，eg:`$(pwd)/sureness.yml`
+> Download from
[github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
+> For detail steps, please refer to [Configure Account
Password](account-modify)
diff --git a/home/docs/start/package-deploy.md
b/home/docs/start/package-deploy.md
index 050121f5c..2d1c383e2 100644
--- a/home/docs/start/package-deploy.md
+++ b/home/docs/start/package-deploy.md
@@ -4,46 +4,76 @@ title: Install HertzBeat via Package
sidebar_label: Install via Package
---
-> You can install and run Apache HertzBeat (incubating) on Linux Windows Mac
system, and CPU supports X86/ARM64.
+:::tip
+You can install and run Apache HertzBeat (incubating) on Linux Windows Mac
system, and CPU supports X86/ARM64.
+Deployment via package relies on Java runtime environment, ensure you have
Java17 environment installed, if not please refer to [official
website](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+:::
-1. Download HertzBeat installation package
- Download installation package `hertzbeat-xx.tar.gz`
`hertzbeat-collector-xx.tar.gz` corresponding to your system environment
+### Deploy HertzBeat Server
+
+1. Download installation package
+
+ Download installation package `apache-hertzbeat-xxx-incubating-bin.tar.gz`
corresponding to your system environment
- [Download Page](/docs/download)
-2. Configure HertzBeat's configuration file(optional)
- Unzip the installation package to the host eg: /opt/hertzbeat
- ```
- $ tar zxvf hertzbeat-xx.tar.gz
- or
- $ unzip -o hertzbeat-xx.zip
- ```
- Modify the configuration file `hertzbeat/config/application.yml` params
according to your needs.
- - If you need to use email to send alarms, you need to replace the email
server parameters `spring.mail` in `application.yml`
- - **Recommended** If you need to use an external Mysql database to replace
the built-in H2 database, you need to replace the `spring.datasource` parameter
in `application.yml` For specific steps, see [Using Mysql to replace H2
database](mysql-change)
- - **Highly recommended** From now on we will mainly support VictoriaMetrics
as a time-series database, if you need to use the time series database
VictoriaMetrics to store metric data, you need to replace the
`warehouse.store.victoria-metrics` parameter in `application.yml` for specific
steps, see [Using VictoriaMetrics to store metrics data](victoria-metrics-init)
- - **Recommended** If you need to use the time series database TDengine to
store metric data, you need to replace the `warehouse.store.td-engine`
parameter in `application.yml` for specific steps, see [Using TDengine to store
metrics data](tdengine-init)
- - **Recommended** If you need to use the time series database IotDB to
store the metric database, you need to replace the `warehouse.storeiot-db`
parameter in `application.yml` For specific steps, see [Use IotDB to store
metrics data](iotdb-init)
-
-3. Configure the account file(optional)
- HertzBeat default built-in three user accounts, respectively
`admin/hertzbeat tom/hertzbeat guest/hertzbeat`
- If you need add, delete or modify account or password, configure
`hertzbeat/config/sureness.yml`. Ignore this step without this demand.
- For detail steps, please refer to [Configure Account
Password](account-modify)
-
-4. Start the service
- Execute the startup script `startup.sh` in the installation directory
`hertzbeat/bin/`, or `startup.bat` in windows.
+2. Configure HertzBeat's configuration file(optional)
+
+ Unzip the installation package to the host eg: /opt/hertzbeat
+ ```
+ $ tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz
+ ```
+
+:::tip
+The configuration file is located in `config/application.yml`, you can modify
the configuration file according to your needs to configure external dependent
services, such as databases, time series databases, etc.
+HertzBeat defaults to using internal services when started, but it is
recommended to switch to external database services in production environments.
+:::
+
+It is recommended to use [PostgreSQL](postgresql-change) for metadata storage
and [VictoriaMetrics](victoria-metrics-init) for metric data storage. Specific
steps are as follows
+
+- [Switch built-in H2 database to PostgreSQL](postgresql-change)
+- [Using VictoriaMetrics to store metric data](victoria-metrics-init)
+
+3. Configure the account file(optional)
+
+ HertzBeat default built-in three user accounts, respectively
`admin/hertzbeat tom/hertzbeat guest/hertzbeat`
+ If you need modify account or password, configure `config/sureness.yml`.
+ For detail steps, please refer to [Configure Account
Password](account-modify)
+
+4. Start the service
+
+ Execute the startup script in the installation directory `bin/`, or
`startup.bat` in windows.
```
$ ./startup.sh
```
-5. Begin to explore HertzBeat
+5. Begin to explore HertzBeat
+
+ Access http://ip:1157/ using browser. You can explore HertzBeat with
default account `admin/hertzbeat` now!
- Access http://localhost:1157/ using browser. You can explore HertzBeat with
default account `admin/hertzbeat` now!
+### Deploy HertzBeat Collector Cluster(Optional)
-6. Deploy collector clusters (Optional)
+:::note
+HertzBeat Collector is a lightweight data collector used to collect and send
data to HertzBeat Server.
+Deploying multiple HertzBeat Collectors can achieve high availability, load
balancing, and cloud-edge collaboration of data.
+:::
- - Download and unzip the collector release package
`hertzbeat-collector-xx.tar.gz` to new machine [Download Page](/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`
- ```yaml
+
+
+1. Download installation package
+
+ Download installation package
`apache-hertzbeat-collector-xxx-incubating-bin.tar.gz` corresponding to your
system environment
+ - [Download Page](/docs/download)
+
+2. Configure the collector configuration file
+
+Unzip the installation package to the host eg: /opt/hertzbeat-collector
+```
+$ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz
+```
+
+Configure the collector configuration yml file `config/application.yml`:
unique `identity` name, running `mode` (public or private), hertzbeat
`manager-host`, hertzbeat `manager-port`
+
+```yaml
collector:
dispatch:
entrance:
@@ -53,15 +83,30 @@ sidebar_label: Install via Package
mode: ${MODE:public}
manager-host: ${MANAGER_HOST:127.0.0.1}
manager-port: ${MANAGER_PORT:1158}
- ```
- - Run command `$ ./bin/startup.sh ` or `bin/startup.bat`
- - Access `http://localhost:1157` and you will see the registered new
collector in dashboard
+```
+
+> Parameters detailed explanation
+
+- `identity` : (optional) Set the unique identifier name of the collector.
Note that the name of the collector must be unique when there are multiple
collectors.
+- `mode` : Configure the running mode (public or private), public cluster mode
or private cloud-edge mode.
+- `manager-host` : Important, configure the address of the connected HertzBeat
Server,
+- `manager-port` : (optional) Configure the port of the connected HertzBeat
Server, default 1158.
+
+3. Start the service
+
+ Run command `$ ./bin/startup.sh ` or `bin/startup.bat`
+
+4. Begin to explore HertzBeat Collector
+
+ Access `http://ip:1157` and you will see the registered new collector in
dashboard
**HAVE FUN**
+----
+
### FAQ
-1. **If using the package not contains JDK, you need to prepare the JAVA
environment in advance**
+1. you need to prepare the JAVA environment in advance
Install JAVA runtime environment-refer to [official
website](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
requirement：JDK17 ENV
@@ -75,18 +120,8 @@ sidebar_label: Install via Package
```
-2. **According to the process deploy，visit http://ip:1157/ no interface**
+2. According to the process deploy，visit http://ip:1157/ no interface
Please refer to the following points to troubleshoot issues:
> 1：If you switch to dependency service MYSQL database，check whether the
> database is created and started successfully.
> 2：Check whether dependent services, IP account and password configuration is
> correct in HertzBeat's configuration file
> `hertzbeat/config/application.yml`.
> 3：Check whether the running log has errors in `hertzbeat/logs/` directory.
> If you haven't solved the issue, report it to the communication group or
> community.
-
-3. **Log an error TDengine connection or insert SQL failed**
-> 1：Check whether database account and password configured is correct, the
database is created.
-> 2：If you install TDengine2.3+ version, you must execute `systemctl start
taosadapter` to start adapter in addition to start the server.
-
-4. **Monitoring historical charts with no data for a long time **
-> 1: Whether the time series database is configured or not, if it is not
configured, there is no historical chart data.
-> 2: If you are using Tdengine, check whether the database `hertzbeat` of
Tdengine is created.
-> 3: HertzBeat's configuration file `application.yml`, the dependent services
in it, the time series, the IP account password, etc. are configured correctly.
-
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current.json
b/home/i18n/en/docusaurus-plugin-content-docs/current.json
index 5d1324036..4e854dee4 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/current.json
+++ b/home/i18n/en/docusaurus-plugin-content-docs/current.json
@@ -23,7 +23,6 @@
"message": "SSH Protocol",
"description": "The label for category ssh in sidebar docs"
},
-
"sidebar.docs.category.telnet": {
"message": "TELNET Protocol",
"description": "The label for category telnet in sidebar docs"
@@ -127,5 +126,25 @@
"sidebar.docs.category.aiConfig": {
"message": "Ai LLM Config",
"description": "The label for category aiConfig in sidebar docs"
+ },
+ "sidebar.docs.category.install": {
+ "message": "Install",
+ "description": "The label for category install in sidebar docs"
+ },
+ "sidebar.docs.category.upgrade": {
+ "message": "Upgrade",
+ "description": "The label for category upgrade in sidebar docs"
+ },
+ "sidebar.docs.category.setting": {
+ "message": "Setting",
+ "description": "The label for category setting in sidebar docs"
+ },
+ "sidebar.docs.category.change-db": {
+ "message": "Change DB",
+ "description": "The label for category change-db in sidebar docs"
+ },
+ "sidebar.docs.category.use-case": {
+ "message": "UseCase",
+ "description": "The label for category use-case in sidebar docs"
}
}
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current.json
b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.5.x.json
similarity index 73%
copy from home/i18n/en/docusaurus-plugin-content-docs/current.json
copy to home/i18n/en/docusaurus-plugin-content-docs/version-v1.5.x.json
index 5d1324036..0c1b1a99b 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/current.json
+++ b/home/i18n/en/docusaurus-plugin-content-docs/version-v1.5.x.json
@@ -1,131 +1,122 @@
{
"version.label": {
- "message": "v1.6.x",
- "description": "The label for version current"
+ "message": "v1.5.x",
+ "description": "The label for version v1.5.x"
},
"sidebar.docs.category.quickstart": {
- "message": "Guides",
+ "message": "quickstart",
"description": "The label for category quickstart in sidebar docs"
},
"sidebar.docs.category.custom": {
- "message": "Custom Monitoring",
+ "message": "custom",
"description": "The label for category custom in sidebar docs"
},
"sidebar.docs.category.http": {
- "message": "HTTP Protocol",
+ "message": "http",
"description": "The label for category http in sidebar docs"
},
"sidebar.docs.category.jdbc": {
- "message": "JDBC Protocol",
+ "message": "jdbc",
"description": "The label for category jdbc in sidebar docs"
},
"sidebar.docs.category.ssh": {
- "message": "SSH Protocol",
+ "message": "ssh",
"description": "The label for category ssh in sidebar docs"
},
-
- "sidebar.docs.category.telnet": {
- "message": "TELNET Protocol",
- "description": "The label for category telnet in sidebar docs"
- },
- "sidebar.docs.category.help": {
- "message": "Help",
- "description": "The label for category help in sidebar docs"
- },
- "sidebar.docs.category.service": {
- "message": "Service Monitor",
- "description": "The label for category service in sidebar docs"
- },
- "sidebar.docs.category.database": {
- "message": "Database Monitor",
- "description": "The label for category database in sidebar docs"
- },
- "sidebar.docs.category.os": {
- "message": "OS Monitor",
- "description": "The label for category os in sidebar docs"
+ "sidebar.docs.category.jmx": {
+ "message": "jmx",
+ "description": "The label for category jmx in sidebar docs"
},
- "sidebar.docs.category.threshold": {
- "message": "Threshold Alarm Setting",
- "description": "The label for category threshold in sidebar docs"
+ "sidebar.docs.category.snmp": {
+ "message": "snmp",
+ "description": "The label for category snmp in sidebar docs"
},
- "sidebar.docs.category.notice": {
- "message": "Alarm Notice Setting",
- "description": "The label for category notice in sidebar docs"
+ "sidebar.docs.category.push": {
+ "message": "push",
+ "description": "The label for category push in sidebar docs"
},
- "sidebar.docs.category.mid": {
- "message": "Middleware Monitor",
- "description": "The label for category mid in sidebar docs"
+ "sidebar.docs.category.NGQL": {
+ "message": "NGQL",
+ "description": "The label for category NGQL in sidebar docs"
},
- "sidebar.docs.category.Others": {
- "message": "Others",
- "description": "The label for category Others in sidebar docs"
+ "sidebar.docs.category.Community": {
+ "message": "Community",
+ "description": "The label for category Community in sidebar docs"
},
- "sidebar.docs.category.cloud-native": {
- "message": "CloudNative Monitor",
- "description": "The label for category cloud-native in sidebar docs"
+ "sidebar.docs.category.contribution": {
+ "message": "contribution",
+ "description": "The label for category contribution in sidebar docs"
},
- "sidebar.docs.category.jmx": {
- "message": "JMX Protocol",
- "description": "The label for category jmx in sidebar docs"
+ "sidebar.docs.category.submit": {
+ "message": "submit",
+ "description": "The label for category submit in sidebar docs"
},
- "sidebar.docs.category.snmp": {
- "message": "SNMP Protocol",
- "description": "The label for category snmp in sidebar docs"
+ "sidebar.docs.category.release": {
+ "message": "release",
+ "description": "The label for category release in sidebar docs"
},
- "sidebar.docs.link.Install via Helm": {
- "message": "Install via Helm",
- "description": "The label for link Install via Helm in sidebar docs,
linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
+ "sidebar.docs.category.help": {
+ "message": "help",
+ "description": "The label for category help in sidebar docs"
},
- "sidebar.docs.category.push": {
- "message": "Push",
- "description": "The label for category push in sidebar docs"
+ "sidebar.docs.category.service": {
+ "message": "service",
+ "description": "The label for category service in sidebar docs"
},
"sidebar.docs.category.program": {
- "message": "Program Monitor",
+ "message": "program",
"description": "The label for category program in sidebar docs"
},
+ "sidebar.docs.category.database": {
+ "message": "database",
+ "description": "The label for category database in sidebar docs"
+ },
"sidebar.docs.category.cache": {
- "message": "Cache Monitor",
+ "message": "cache",
"description": "The label for category cache in sidebar docs"
},
+ "sidebar.docs.category.os": {
+ "message": "os",
+ "description": "The label for category os in sidebar docs"
+ },
+ "sidebar.docs.category.mid": {
+ "message": "mid",
+ "description": "The label for category mid in sidebar docs"
+ },
"sidebar.docs.category.bigdata": {
- "message": "Bigdata Monitor",
+ "message": "bigdata",
"description": "The label for category bigdata in sidebar docs"
},
"sidebar.docs.category.webserver": {
- "message": "WebServer Monitor",
+ "message": "webserver",
"description": "The label for category webserver in sidebar docs"
},
- "sidebar.docs.category.contribution": {
- "message": "Contribution Guide",
- "description": "The label for category contribution in sidebar docs"
- },
- "sidebar.docs.category.submit": {
- "message": "Submit Guide",
- "description": "The label for category submit in sidebar docs"
- },
- "sidebar.docs.category.release": {
- "message": "Release Guide",
- "description": "The label for category release in sidebar docs"
+ "sidebar.docs.category.cloud-native": {
+ "message": "cloud-native",
+ "description": "The label for category cloud-native in sidebar docs"
},
- "sidebar.docs.category.Community": {
- "message": "Community",
- "description": "The label for category Community in sidebar docs"
+ "sidebar.docs.category.llm": {
+ "message": "llm",
+ "description": "The label for category llm in sidebar docs"
},
"sidebar.docs.category.network": {
- "message": "Network Monitor",
+ "message": "network",
"description": "The label for category network in sidebar docs"
},
- "sidebar.docs.category.NGQL": {
- "message": "NGQL",
- "description": "The label for category NGQL in sidebar docs"
+ "sidebar.docs.category.threshold": {
+ "message": "threshold",
+ "description": "The label for category threshold in sidebar docs"
},
- "sidebar.docs.category.llm": {
- "message": "Ai LLM Monitor",
- "description": "The label for category llm in sidebar docs"
+ "sidebar.docs.category.notice": {
+ "message": "notice",
+ "description": "The label for category notice in sidebar docs"
},
- "sidebar.docs.category.aiConfig": {
- "message": "Ai LLM Config",
- "description": "The label for category aiConfig in sidebar docs"
+ "sidebar.docs.category.Others": {
+ "message": "Others",
+ "description": "The label for category Others in sidebar docs"
+ },
+ "sidebar.docs.link.Install via Helm": {
+ "message": "Install via Helm",
+ "description": "The label for link Install via Helm in sidebar docs,
linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
}
}
diff --git a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json
index cbf886859..d2a8b4646 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current.json
@@ -4,7 +4,7 @@
"description": "The label for version current"
},
"sidebar.docs.category.quickstart": {
- "message": "快速入门",
+ "message": "快速开始",
"description": "The label for category quickstart in sidebar docs"
},
"sidebar.docs.category.custom": {
@@ -130,5 +130,25 @@
"sidebar.docs.category.aiConfig": {
"message": "Ai大模型配置",
"description": "The label for category aiConfig in sidebar docs"
+ },
+ "sidebar.docs.category.install": {
+ "message": "安装",
+ "description": "The label for category install in sidebar docs"
+ },
+ "sidebar.docs.category.upgrade": {
+ "message": "升级",
+ "description": "The label for category upgrade in sidebar docs"
+ },
+ "sidebar.docs.category.setting": {
+ "message": "配置",
+ "description": "The label for category setting in sidebar docs"
+ },
+ "sidebar.docs.category.change-db": {
+ "message": "数据库切换",
+ "description": "The label for category change-db in sidebar docs"
+ },
+ "sidebar.docs.category.use-case": {
+ "message": "使用案例",
+ "description": "The label for category use-case in sidebar docs"
}
}
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md
index 5fd594667..5986e1092 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mariadb.md
@@ -7,6 +7,12 @@ keywords: [开源监控系统, 开源数据库监控, MariaDB数据库监控]
> 对MariaDB数据库的通用性能指标进行采集监控。支持MariaDB5+。
+### 注意，必须添加 MYSQL jdbc 驱动 jar
+
+- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar.
https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0
+- 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下.
+- 重启 HertzBeat 服务。
+
### 配置参数
| 参数名称 | 参数帮助描述 |
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md
index f93b2fdd7..811cc2df1 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/mysql.md
@@ -7,10 +7,11 @@ keywords: [开源监控系统, 开源数据库监控, Mysql数据库监控]
> 对MYSQL数据库的通用性能指标进行采集监控。支持MYSQL5+。
-### 添加 MYSQL jdbc 驱动 jar
+### 注意，必须添加 MYSQL jdbc 驱动 jar
- 下载 MYSQL jdbc driver jar, 例如 mysql-connector-java-8.1.0.jar.
https://mvnrepository.com/artifact/com.mysql/mysql-connector-j/8.1.0
- 将此 jar 包拷贝放入 HertzBeat 的安装目录下的 `ext-lib` 目录下.
+- 重启 HertzBeat 服务。
### 配置参数
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md
index 49136e51c..2edf7bf6f 100644
--- a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/help/oracle.md
@@ -7,6 +7,12 @@ keywords: [开源监控系统, 开源数据库监控, Oracle数据库监控]
> 对ORACLE数据库的通用性能指标进行采集监控。
+### 注意, 必须添加 ORACLE jdbc 驱动 jar
+
+- 下载 ORACLE jdbc 驱动 jar 包，例如
ojdbc8.jar。[下载](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar)
[oracle-i18n](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar)
+- 将 jar 包复制到 `hertzbeat/ext-lib` 目录下。
+- 重启 HertzBeat 服务。
+
### 配置参数
| 参数名称 | 参数帮助描述 |
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md
new file mode 100644
index 000000000..8be78289b
--- /dev/null
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-compose-deploy.md
@@ -0,0 +1,69 @@
+---
+id: docker-compose-deploy
+title: 通过 Docker Compose 方式安装 HertzBeat
+sidebar_label: Docker Compose方式安装
+---
+
+:::tip
+推荐使用 Docker Compose 方式一键部署 HertzBeat 及其依赖服务。
+:::
+
+:::note
+需您的环境中已经拥有 Docker 环境 和 Docker Compose 环境 ，若未安装请参考
[Docker官网文档](https://docs.docker.com/compose/install/)
+执行命令 `docker compose version` 检查是否拥有 Docker Compose 环境。
+:::
+
+
+
+1. 下载启动脚本包
+
+从
[下载地址](https://github.com/apache/hertzbeat/releases/download/v1.6.0/apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz)
下载安装脚本包 `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz`
+
+2. 选择使用 HertzBeat + PostgreSQL + VictoriaMetrics 方案
+
+:::tip
+- `apache-hertzbeat-xxx-incubating-docker-compose.tar.gz` 解压后包含多个部署方案，这里我们推荐选择
`hertzbeat-postgresql-victoria-metrics` 方案。
+- 其它部署方式请详细阅读各个部署方案的 README.md 文件, MySQL 方案需要自行准备 MySQL 驱动包。
+:::
+
+- 解压脚本包
+
+```
+$ tar zxvf apache-hertzbeat-1.6.0-incubating-docker-compose.tar.gz
+```
+
+- 进入解压目录, 选择 `HertzBeat + PostgreSQL + VictoriaMetrics` 一键部署
+
+```
+$ cd apache-hertzbeat-1.6.0-incubating-docker-compose
+$ cd hertzbeat-postgresql-victoria-metrics
+```
+
+- 一键启动
+
+> 在 `hertzbeat-postgresql-victoria-metrics` 目录下执行以下命令
+
+```
+docker-compose up -d
+```
+
+- 查看服务状态
+
+> 查看各个容器的运行状态，up 为正常运行状态
+
+```
+docker-compose ps
+```
+
+4. 开始探索 HertzBeat
+ 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。
+
+**HAVE FUN**
+
+
+----
+
+### 部署常见问题
+
+**最多的问题就是容器网络问题，请先提前排查**
+
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md
index a5c1e86c8..5804522bd 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/docker-deploy.md
@@ -1,72 +1,24 @@
---
id: docker-deploy
title: 通过 Docker 方式安装 HertzBeat
-sidebar_label: Docker方式部署
+sidebar_label: Docker方式安装
---
-> 推荐使用 Docker 部署 Apache HertzBeat (incubating)
-
-1. 下载安装Docker环境
- Docker 工具自身的下载请参考以下资料：
- [Docker官网文档](https://docs.docker.com/get-docker/)
- [菜鸟教程-Docker教程](https://www.runoob.com/docker/docker-tutorial.html)
- 安装完毕后终端查看Docker版本是否正常输出。
-
- ```
- $ docker -v
- Docker version 20.10.12, build e91ed57
- ```
-
-2. 拉取HertzBeat Docker镜像
- 镜像版本TAG可查看 [dockerhub
官方镜像仓库](https://hub.docker.com/r/apache/hertzbeat/tags)
- 或者使用 [quay.io 镜像仓库](https://quay.io/repository/tancloud/hertzbeat)
-
- ```shell
- $ docker pull apache/hertzbeat
- $ docker pull apache/hertzbeat-collector
- ```
- 若网络超时或者使用
- ```shell
- $ docker pull quay.io/tancloud/hertzbeat
- $ docker pull quay.io/tancloud/hertzbeat-collector
- ```
-
-3. 部署HertzBeat您可能需要掌握的几条命令
-
- ```shell
- #查看所有容器(在运行和已经停止运行的容器)
- $ docker ps -a
- #启动/终止/重启/运行状态
- $ docker start/stop/restart/stats 容器id或者容器名
- #进入容器并打开容器的shell终端
- $ docker exec -it 容器id或者容器名 /bin/bash
- #退出容器终端
- ctrl+p然后ctrl+q
- #完全退出容器的终端
- ctrl+d或者
- $ exit
- ```
-
-4. 挂载并配置HertzBeat的配置文件(可选)
- 下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml
- 下载源
[github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
- - 若需使用邮件发送告警，需替换 `application.yml` 里面的邮件服务器参数
- -
**推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数
具体步骤参见 [H2数据库切换为MYSQL](mysql-change)）
- -
**推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数
具体步骤参见 [使用victoria-metrics存储指标数据](victoria-metrics-init)
-
-5. 挂载并配置HertzBeat用户配置文件，自定义用户密码(可选)
- HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
- 若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤
- 下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml
- 下载源
[github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
- 具体修改步骤参考 [配置修改账户密码](account-modify)
-
-6. 启动HertzBeat Docker容器
+:::tip
+使用 Docker 方式一键启动 HertzBeat 最小可用环境，无外部服务依赖，方便快速体验。
+但不建议在生产环境中使用，生产环境建议使用 Docker Compose 方式部署, 安装包方式部署, Kubernetes 方式部署。
+:::
+
+:::note
+需您的环境中已经拥有 Docker 环境，若未安装请参考 [Docker官网文档](https://docs.docker.com/get-docker/)
+:::
+
+### 部署 HertzBeat Server
+
+1. 执行以下命令
```shell
$ docker run -d -p 1157:1157 -p 1158:1158 \
- -e LANG=zh_CN.UTF-8 \
- -e TZ=Asia/Shanghai \
-v $(pwd)/data:/opt/hertzbeat/data \
-v $(pwd)/logs:/opt/hertzbeat/logs \
-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml \
@@ -75,40 +27,39 @@ $ docker run -d -p 1157:1157 -p 1158:1158 \
--name hertzbeat apache/hertzbeat
```
-
这条命令启动一个运行HertzBeat的Docker容器，并且将容器的1157端口映射到宿主机的1157端口上。若宿主机已有进程占用该端口，则需要修改主机映射端口。
- - `docker run -d` : 通过Docker运行一个容器,使其在后台运行
- - `-e LANG=zh_CN.UTF-8` : 设置系统语言
- - `-e TZ=Asia/Shanghai` : 设置系统时区
- - `-p 1157:1157 -p 1158:1158` :
映射容器端口到主机端口，请注意，前面是宿主机的端口号，后面是容器的端口号。1157是WEB端口，1158是集群端口。
- - `-v $(pwd)/data:/opt/hertzbeat/data` : (可选，数据持久化)重要⚠️
挂载H2数据库文件到本地主机，保证数据不会因为容器的创建删除而丢失
- - `-v $(pwd)/logs:/opt/hertzbeat/logs` :
(可选，不需要可删除)挂载日志文件到本地主机，保证日志不会因为容器的创建删除而丢失，方便查看
- - `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` :
(可选,不需要可删除)挂载上上一步修改的本地配置文件到容器中，即使用本地配置文件覆盖容器配置文件。我们需要修改此配置文件的MYSQL，TDengine配置信息来连接外部服务。
- - `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` :
(可选,不需要可删除)挂载上一步修改的账户配置文件到容器中，若无修改账户需求可删除此命令参数。
- - `-v $(pwd)/ext-lib:/opt/hertzbeat/ext-lib` :
(可选,不需要可删除)根据自己下载的mysql/oracle等数据库连接驱动jar复制到宿主机相应目录并挂载到ext-lib目录
-
mysql:https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip
- oracle:https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar
https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar
- - `还有一种自定义数据源连接驱动不需要挂载的方式`(可选)这种方式是把自己需要的数据源驱动直接放到容器内部
- - `docker cp $(pwd)/mysql-connector-java-8.0.18.jar
hertzbeat:/opt/hertzbeat/ext-lib` 使用docker cp 命令先把自己下载好的数据源驱动cp到容器内部
- - `docker restart hertzbeat` 重启成功后就要可以正常使用了
- - `docker commit -a "operator" -m "在容器内部/ext-lib文件夹下新增了自定义的数据源驱动"
hertzbeat hertzbeat:版本号自己定义`(可选) 如果想自己做一个自定义镜像可以使用此命令 ,-a 当前操作人 -m 对自己重做的容器进行描述
-
-
- - 注意⚠️ 挂载文件时，前面参数为你自定义本地文件地址，后面参数为docker容器内文件地址(固定)
-
- - `--name hertzbeat` : 命名容器名称 hertzbeat
-
- -
`--restart=always`：(可选，不需要可删除)使容器在Docker启动后自动重启。若您未在容器创建时指定该参数，可通过以下命令实现该容器自启。
+> 命令参数详解
+
+- `docker run -d` : 通过 Docker 后台运行容器
+- `-p 1157:1157 -p 1158:1158` :
映射容器端口到主机端口(前面是宿主机的端口号，后面是容器的端口号)。1157是页面端口，1158是集群端口。
+- `-v $(pwd)/data:/opt/hertzbeat/data` : (可选，数据持久化)
重要，挂载数据库文件到本地主机，保证数据不会因为容器的创建删除而丢失
+- `-v $(pwd)/logs:/opt/hertzbeat/logs` : (可选) 挂载日志文件到本地主机方便查看
+- `-v $(pwd)/application.yml:/opt/hertzbeat/config/application.yml` : (可选)
挂载配置文件到容器中(请确保本地已有此文件)。[下载源](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
+- `-v $(pwd)/sureness.yml:/opt/hertzbeat/config/sureness.yml` : (可选)
挂载账户配置文件到容器中(请确保本地已有此文件)。[下载源](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
+- `-v $(pwd)/ext-lib:/opt/hertzbeat/ext-lib` : (可选) 挂载外部的第三方 JAR 包
[mysql-jdbc](https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.25.zip)
[oracle-jdbc](https://download.oracle.com/otn-pub/otn_software/jdbc/234/ojdbc8.jar)
[oracle-i18n](https://repo.mavenlibs.com/maven/com/oracle/database/nls/orai18n/21.5.0.0/orai18n-21.5.0.0.jar)
+- `--name hertzbeat` : (可选) 命名容器名称为 hertzbeat
+- `--restart=always` : (可选) 配置容器自动重启。
+- `apache/hertzbeat` :
使用[官方应用镜像](https://hub.docker.com/r/apache/hertzbeat)来启动容器,
若网络超时可用`quay.io/tancloud/hertzbeat`代替。
+
+:::tip
+- 标记为可选的参数，非必填项，若不需要则删除。
+- 此将容器的 1157,1158 端口映射到宿主机的 1157,1158 端口上。若宿主机该端口已被占用，则需修改主机映射端口。
+- 挂载文件时，前面参数为你自定义本地文件地址，后面参数为容器内文件地址。挂载时请确保你本地已有此文件。
+- 可执行```docker update --restart=always hertzbeat```配置容器自动重启。
+:::
+
+2. 开始探索 HertzBeat
+ 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。
- ```shell
- $ docker update --restart=always hertzbeat
- ```
+### 部署 HertzBeat Collector 集群(可选)
- - `apache/hertzbeat` :
使用拉取最新的的HertzBeat官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat`代替。**
+:::note
+HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数据发送到 HertzBeat Server。
+通过部署多个 HertzBeat Collector 可以实现数据的高可用，负载均衡和云边协同。
+:::
-7. 开始探索HertzBeat
- 浏览器访问 http://ip:1157/ 即可开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。
+
-8. 部署采集器集群(可选)
+1. 执行以下命令
```shell
$ docker run -d \
@@ -118,31 +69,41 @@ $ docker run -d \
-e MANAGER_PORT=1158 \
--name hertzbeat-collector apache/hertzbeat-collector
```
-
- 这条命令启动一个运行HertzBeat采集器的Docker容器，并直连上了HertzBeat主服务节点。
- - `docker run -d` : 通过Docker运行一个容器,使其在后台运行
- - `-e IDENTITY=custom-collector-name` : (可选)
设置采集器的唯一标识名称。⚠️注意多采集器时采集器名称需保证唯一性。
- - `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。
- - `-e MANAGER_HOST=127.0.0.1` : 重要⚠️ 设置连接的主HertzBeat服务地址IP。
- - `-e MANAGER_PORT=1158` : (可选) 设置连接的主HertzBeat服务地址端口，默认 1158.
- - `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` :
(可选，不需要可删除)挂载日志文件到本地主机，保证日志不会因为容器的创建删除而丢失，方便查看
- - `--name hertzbeat-collector` : 命名容器名称 hertzbeat-collector
- - `apache/hertzbeat-collector` :
使用拉取最新的的HertzBeat采集器官方发布的应用镜像来启动容器,**若使用`quay.io`镜像需用参数`quay.io/tancloud/hertzbeat-collector`代替。**
-
-8. 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器
+> 命令参数详解
+
+- `docker run -d` : 通过 Docker 后台运行容器
+- `-e IDENTITY=custom-collector-name` : (可选) 设置采集器的唯一标识名称。注意多采集器时名称需保证唯一性。
+- `-e MODE=public` : 配置运行模式(public or private), 公共集群模式或私有云边模式。
+- `-e MANAGER_HOST=127.0.0.1` : 重要, 配置连接的 HertzBeat Server 地址，127.0.0.1 需替换为
HertzBeat Server 对外 IP 地址。
+- `-e MANAGER_PORT=1158` : (可选) 配置连接的 HertzBeat Server 端口，默认 1158.
+- `-v $(pwd)/logs:/opt/hertzbeat-collector/logs` : (可选)挂载日志文件到本地主机方便查看
+- `--name hertzbeat-collector` : 命名容器名称为 hertzbeat-collector
+- `apache/hertzbeat-collector` :
使用[官方应用镜像](https://hub.docker.com/r/apache/hertzbeat-collector)来启动容器,
若网络超时可用`quay.io/tancloud/hertzbeat-collector`代替。
+
+:::tip
+- `MANAGER_HOST=127.0.0.1` 中的 `127.0.0.1` 需被替换为 HertzBeat Server 对外 IP 地址。
+- 标记为可选的参数，非必填项，若不需要则删除。
+- 挂载文件时，前面参数为你自定义本地文件地址，后面参数为容器内文件地址。挂载时请确保你本地已有此文件。
+- 可执行```docker update --restart=always hertzbeat-collector```配置容器自动重启。
+:::
+
+2. 开始探索 HertzBeat Collector
+ 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。
**HAVE FUN**
-### Docker部署常见问题
+----
+
+### Docker 方式部署常见问题
**最多的问题就是网络问题，请先提前排查**
-1.
**MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败**
+1.
MYSQL,TDENGINE或IotDB和HertzBeat都Docker部署在同一主机上，HertzBeat使用localhost或127.0.0.1连接数据库失败
此问题本质为Docker容器访问宿主机端口连接失败，由于docker默认网络模式为Bridge模式，其通过localhost访问不到宿主机。
> 解决办法一：配置application.yml将数据库的连接地址由localhost修改为宿主机的对外IP
> 解决办法二：使用Host网络模式启动Docker，即使Docker容器和宿主机共享网络 `docker run -d --network host
> .....`
-2. **按照流程部署，访问 http://ip:1157/ 无界面**
+2. 按照流程部署，访问 http://ip:1157/ 无界面
请参考下面几点排查问题：
> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功
> 二：HertzBeat的配置文件 `application.yml` 里面的依赖服务IP账户密码等配置是否正确
@@ -158,4 +119,22 @@ $ docker run -d \
> 注意⚠️若hertzbeat和外置数据库都为docker容器在同一主机下启动，容器之间默认不能用127.0.0.1通讯，改为主机IP
> 可根据logs目录下启动日志排查
+5. application.yml 是干什么用的
+
+> 此文件是HertzBeat的配置文件，用于配置HertzBeat的各种参数，如数据库连接信息，时序数据库配置等。
+
+下载 `application.yml` 文件到主机目录下，例如: $(pwd)/application.yml
+下载源
[github/script/application.yml](https://github.com/apache/hertzbeat/raw/master/script/application.yml)
+- 若需使用邮件发送告警，需替换 `application.yml` 里面的邮件服务器参数
+- 若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数 具体步骤参见
[H2数据库切换为MYSQL](mysql-change)）
+-
若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数
具体步骤参见 [使用victoria-metrics存储指标数据](victoria-metrics-init)
+
+6. sureness.yml 是干什么用的
+
+> 此文件是HertzBeat的用户配置文件，用于配置HertzBeat的用户信息，如账户密码等。
+HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
+若需要新增删除修改账户或密码，可以通过配置 `sureness.yml` 实现，若无此需求可忽略此步骤
+下载 `sureness.yml` 文件到主机目录下，例如: $(pwd)/sureness.yml
+下载源
[github/script/sureness.yml](https://github.com/apache/hertzbeat/raw/master/script/sureness.yml)
+具体修改步骤参考 [配置修改账户密码](account-modify)
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md
index b5f9d7e04..7a0e627c5 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/package-deploy.md
@@ -1,46 +1,76 @@
---
id: package-deploy
title: 通过安装包安装 HertzBeat
-sidebar_label: 安装包方式部署
+sidebar_label: 安装包方式安装
---
-> Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。
+
+:::tip
+Apache HertzBeat (incubating) 支持在Linux Windows Mac系统安装运行，CPU支持X86/ARM64。
+安装包方式依赖 Java 运行环境，需您的环境中已经拥有 Java17 环境，若未安装请参考
[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
+:::
+
+### 部署 HertzBeat Server
-1. 下载HertzBeat安装包
- 下载您系统环境对应的安装包 `hertzbeat-xx.tar.gz` `hertzbeat-collector-xx.tar.gz`
- - [下载页面](/docs/download)
-
-2. 配置HertzBeat的配置文件(可选)
- 解压安装包到主机 eg: /opt/hertzbeat
- ```
- $ tar zxvf hertzbeat-xx.tar.gz
- or
- $ unzip -o hertzbeat-xx.zip
- ```
- 修改位于 `hertzbeat/config/application.yml` 的配置文件(可选)，您可以根据需求修改配置文件
- - 若需使用邮件发送告警，需替换`application.yml`里面的邮件服务器参数
- -
**推荐**若需使用外置Mysql数据库替换内置H2数据库，需替换`application.yml`里面的`spring.datasource`参数
具体步骤参见 [H2数据库切换为MYSQL](mysql-change)）
- - **强烈推荐**
以后我们将主要支持VictoriaMetrics作为时序数据库，若需使用时序数据库VictoriaMetrics来存储指标数据，需替换`application.yml`里面的`warehouse.store.victoria-metrics`参数
具体步骤参见 [使用VictoriaMetrics存储指标数据](victoria-metrics-init)
- -
**推荐**若需使用时序数据库TDengine来存储指标数据，需替换`application.yml`里面的`warehouse.store.td-engine`参数
具体步骤参见 [使用TDengine存储指标数据](tdengine-init)
- -
**推荐**若需使用时序数据库IotDB来存储指标数据库，需替换`application.yml`里面的`warehouse.storeiot-db`参数
具体步骤参见 [使用IotDB存储指标数据](iotdb-init)
-
-3. 配置用户配置文件(可选,自定义配置用户密码)
- HertzBeat默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
- 若需要新增删除修改账户或密码，可以通过修改位于 `hertzbeat/config/sureness.yml` 的配置文件实现，若无此需求可忽略此步骤
- 具体参考 [配置修改账户密码](account-modify)
-
-4. 部署启动
- 执行位于安装目录hertzbeat/bin/下的启动脚本 startup.sh, windows环境下为 startup.bat
- ```
- $ ./startup.sh
- ```
+1. 下载安装包
+
+从 [下载页面](/docs/download) 下载您系统环境对应的安装包版本
`apache-hertzbeat-xxx-incubating-bin.tar.gz`
+
+2. 设置配置文件(可选)
+
+解压安装包到主机 eg: /opt/hertzbeat
+```
+$ tar zxvf apache-hertzbeat-xxx-incubating-bin.tar.gz
+```
+:::tip
+位于 `config/application.yml` 的配置文件，您可以根据需求修改配置文件来配置外部依赖的服务，如数据库，时序数据库等参数。
+HertzBeat 启动时默认全使用内部服务，但生产环境建议切换为外部数据库服务。
+:::
+
+建议元数据存储使用 [PostgreSQL](postgresql-change), 指标数据存储使用
[VictoriaMetrics](victoria-metrics-init), 具体步骤参见
+
+- [内置 H2 数据库切换为 PostgreSQL](postgresql-change)
+- [使用 VictoriaMetrics 存储指标数据](victoria-metrics-init)
+
+3. 配置账户文件(可选)
+
+HertzBeat 默认内置三个用户账户,分别为 admin/hertzbeat tom/hertzbeat guest/hertzbeat
+若需要新增删除修改账户或密码，可以通过修改位于 `config/sureness.yml` 的配置文件实现，具体参考
+
+- [配置修改账户密码](account-modify)
+
+4. 启动
+
+执行位于安装目录 bin 下的启动脚本 startup.sh, windows 环境下为 startup.bat
+```
+$ ./startup.sh
+```
+
+5. 开始探索HertzBeat
+浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。
-5. 开始探索HertzBeat
- 浏览器访问 http://ip:1157/ 即刻开始探索使用HertzBeat，默认账户密码 admin/hertzbeat。
+### 部署 HertzBeat Collector 集群(可选)
-6. 部署采集器集群(可选)
- - 下载解压您系统环境对应采集器安装包`hertzbeat-collector-xx.tar.gz`到规划的另一台部署主机上
[下载页面](/docs/download)
- - 配置采集器的配置文件 `hertzbeat-collector/config/application.yml`
里面的连接主HertzBeat服务的对外IP，端口，当前采集器名称(需保证唯一性)等参数 `identity` `mode` (public or
private) `manager-host` `manager-port`
- ```yaml
+:::note
+HertzBeat Collector 是一个轻量级的数据采集器，用于采集并将数据发送到 HertzBeat Server。
+通过部署多个 HertzBeat Collector 可以实现数据的高可用，负载均衡和云边协同。
+:::
+
+
+
+1. 下载安装包
+
+从 [下载页面](/docs/download) 下载您系统环境对应的安装包版本
`apache-hertzbeat-collector-xxx-incubating-bin.tar.gz`
+
+2. 设置配置文件
+
+解压安装包到主机 eg: /opt/hertzbeat-collector
+```
+$ tar zxvf apache-hertzbeat-collector-xxx-incubating-bin.tar.gz
+```
+
+配置采集器的配置文件 `config/application.yml` 里面的 HertzBeat Server 连接 IP, 端口,
采集器名称(需保证唯一性)等参数。
+
+```yaml
collector:
dispatch:
entrance:
@@ -50,18 +80,35 @@ sidebar_label: 安装包方式部署
mode: ${MODE:public}
manager-host: ${MANAGER_HOST:127.0.0.1}
manager-port: ${MANAGER_PORT:1158}
- ```
- - 启动 `$ ./bin/startup.sh ` 或 `bin/startup.bat`
- - 浏览器访问主HertzBeat服务 `http://localhost:1157` 查看概览页面即可看到注册上来的新采集器
+```
+
+> 参数详解
+
+- `identity` : (可选) 设置采集器的唯一标识名称。注意多采集器时名称需保证唯一性。
+- `mode` : 配置运行模式(public or private), 公共集群模式或私有云边模式。
+- `manager-host` : 重要, 配置连接的 HertzBeat Server 地址，
+- `manager-port` : (可选) 配置连接的 HertzBeat Server 端口，默认 1158.
+
+3. 启动
+
+执行位于安装目录 hertzbeat-collector/bin/ 下的启动脚本 startup.sh, windows 环境下为 startup.bat
+```
+$ ./startup.sh
+```
+
+4. 开始探索 HertzBeat Collector
+ 浏览器访问 http://ip:1157/ 即可开始探索使用，默认账户密码 admin/hertzbeat。
**HAVE FUN**
+
+----
### 安装包部署常见问题
**最多的问题就是网络环境问题，请先提前排查**
-1. **若您使用的是不含JDK的安装包，需您提前准备JAVA运行环境**
+1. 启动失败，需您提前准备JAVA运行环境
安装JAVA运行环境-可参考[官方网站](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
要求：JAVA17环境
@@ -75,17 +122,9 @@ sidebar_label: 安装包方式部署
```
-2. **按照流程部署，访问 http://ip:1157/ 无界面**
+2. 按照流程部署，访问 http://ip:1157/ 无界面
请参考下面几点排查问题：
> 一：若切换了依赖服务MYSQL数据库，排查数据库是否成功创建，是否启动成功
> 二：HertzBeat的配置文件 `hertzbeat/config/application.yml` 里面的依赖服务IP账户密码等配置是否正确
> 三：若都无问题可以查看 `hertzbeat/logs/` 目录下面的运行日志是否有明显错误，提issue或交流群或社区反馈
-3. **日志报错TDengine连接或插入SQL失败**
-> 一：排查配置的数据库账户密码是否正确，数据库是否创建
-> 二：若是安装包安装的TDengine2.3+，除了启动server外，还需执行 `systemctl start taosadapter` 启动
adapter
-
-4. **监控历史图表长时间都一直无数据**
-> 一：时序数据库是否配置，未配置则无历史图表数据
-> 二：若使用了Tdengine，排查Tdengine的数据库`hertzbeat`是否创建
-> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确
diff --git
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md
index 62cd3e157..f3892a20a 100644
---
a/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md
+++
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/current/start/sslcert-practice.md
@@ -1,7 +1,7 @@
---
id: ssl-cert-practice
title: SSL证书过期监控使用案例
-sidebar_label: 使用案例
+sidebar_label: SSL证书过期监控使用案例
---
diff --git a/home/i18n/en/docusaurus-plugin-content-docs/current.json
b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x.json
similarity index 73%
copy from home/i18n/en/docusaurus-plugin-content-docs/current.json
copy to home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x.json
index 5d1324036..0c1b1a99b 100644
--- a/home/i18n/en/docusaurus-plugin-content-docs/current.json
+++ b/home/i18n/zh-cn/docusaurus-plugin-content-docs/version-v1.5.x.json
@@ -1,131 +1,122 @@
{
"version.label": {
- "message": "v1.6.x",
- "description": "The label for version current"
+ "message": "v1.5.x",
+ "description": "The label for version v1.5.x"
},
"sidebar.docs.category.quickstart": {
- "message": "Guides",
+ "message": "quickstart",
"description": "The label for category quickstart in sidebar docs"
},
"sidebar.docs.category.custom": {
- "message": "Custom Monitoring",
+ "message": "custom",
"description": "The label for category custom in sidebar docs"
},
"sidebar.docs.category.http": {
- "message": "HTTP Protocol",
+ "message": "http",
"description": "The label for category http in sidebar docs"
},
"sidebar.docs.category.jdbc": {
- "message": "JDBC Protocol",
+ "message": "jdbc",
"description": "The label for category jdbc in sidebar docs"
},
"sidebar.docs.category.ssh": {
- "message": "SSH Protocol",
+ "message": "ssh",
"description": "The label for category ssh in sidebar docs"
},
-
- "sidebar.docs.category.telnet": {
- "message": "TELNET Protocol",
- "description": "The label for category telnet in sidebar docs"
- },
- "sidebar.docs.category.help": {
- "message": "Help",
- "description": "The label for category help in sidebar docs"
- },
- "sidebar.docs.category.service": {
- "message": "Service Monitor",
- "description": "The label for category service in sidebar docs"
- },
- "sidebar.docs.category.database": {
- "message": "Database Monitor",
- "description": "The label for category database in sidebar docs"
- },
- "sidebar.docs.category.os": {
- "message": "OS Monitor",
- "description": "The label for category os in sidebar docs"
+ "sidebar.docs.category.jmx": {
+ "message": "jmx",
+ "description": "The label for category jmx in sidebar docs"
},
- "sidebar.docs.category.threshold": {
- "message": "Threshold Alarm Setting",
- "description": "The label for category threshold in sidebar docs"
+ "sidebar.docs.category.snmp": {
+ "message": "snmp",
+ "description": "The label for category snmp in sidebar docs"
},
- "sidebar.docs.category.notice": {
- "message": "Alarm Notice Setting",
- "description": "The label for category notice in sidebar docs"
+ "sidebar.docs.category.push": {
+ "message": "push",
+ "description": "The label for category push in sidebar docs"
},
- "sidebar.docs.category.mid": {
- "message": "Middleware Monitor",
- "description": "The label for category mid in sidebar docs"
+ "sidebar.docs.category.NGQL": {
+ "message": "NGQL",
+ "description": "The label for category NGQL in sidebar docs"
},
- "sidebar.docs.category.Others": {
- "message": "Others",
- "description": "The label for category Others in sidebar docs"
+ "sidebar.docs.category.Community": {
+ "message": "Community",
+ "description": "The label for category Community in sidebar docs"
},
- "sidebar.docs.category.cloud-native": {
- "message": "CloudNative Monitor",
- "description": "The label for category cloud-native in sidebar docs"
+ "sidebar.docs.category.contribution": {
+ "message": "contribution",
+ "description": "The label for category contribution in sidebar docs"
},
- "sidebar.docs.category.jmx": {
- "message": "JMX Protocol",
- "description": "The label for category jmx in sidebar docs"
+ "sidebar.docs.category.submit": {
+ "message": "submit",
+ "description": "The label for category submit in sidebar docs"
},
- "sidebar.docs.category.snmp": {
- "message": "SNMP Protocol",
- "description": "The label for category snmp in sidebar docs"
+ "sidebar.docs.category.release": {
+ "message": "release",
+ "description": "The label for category release in sidebar docs"
},
- "sidebar.docs.link.Install via Helm": {
- "message": "Install via Helm",
- "description": "The label for link Install via Helm in sidebar docs,
linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
+ "sidebar.docs.category.help": {
+ "message": "help",
+ "description": "The label for category help in sidebar docs"
},
- "sidebar.docs.category.push": {
- "message": "Push",
- "description": "The label for category push in sidebar docs"
+ "sidebar.docs.category.service": {
+ "message": "service",
+ "description": "The label for category service in sidebar docs"
},
"sidebar.docs.category.program": {
- "message": "Program Monitor",
+ "message": "program",
"description": "The label for category program in sidebar docs"
},
+ "sidebar.docs.category.database": {
+ "message": "database",
+ "description": "The label for category database in sidebar docs"
+ },
"sidebar.docs.category.cache": {
- "message": "Cache Monitor",
+ "message": "cache",
"description": "The label for category cache in sidebar docs"
},
+ "sidebar.docs.category.os": {
+ "message": "os",
+ "description": "The label for category os in sidebar docs"
+ },
+ "sidebar.docs.category.mid": {
+ "message": "mid",
+ "description": "The label for category mid in sidebar docs"
+ },
"sidebar.docs.category.bigdata": {
- "message": "Bigdata Monitor",
+ "message": "bigdata",
"description": "The label for category bigdata in sidebar docs"
},
"sidebar.docs.category.webserver": {
- "message": "WebServer Monitor",
+ "message": "webserver",
"description": "The label for category webserver in sidebar docs"
},
- "sidebar.docs.category.contribution": {
- "message": "Contribution Guide",
- "description": "The label for category contribution in sidebar docs"
- },
- "sidebar.docs.category.submit": {
- "message": "Submit Guide",
- "description": "The label for category submit in sidebar docs"
- },
- "sidebar.docs.category.release": {
- "message": "Release Guide",
- "description": "The label for category release in sidebar docs"
+ "sidebar.docs.category.cloud-native": {
+ "message": "cloud-native",
+ "description": "The label for category cloud-native in sidebar docs"
},
- "sidebar.docs.category.Community": {
- "message": "Community",
- "description": "The label for category Community in sidebar docs"
+ "sidebar.docs.category.llm": {
+ "message": "llm",
+ "description": "The label for category llm in sidebar docs"
},
"sidebar.docs.category.network": {
- "message": "Network Monitor",
+ "message": "network",
"description": "The label for category network in sidebar docs"
},
- "sidebar.docs.category.NGQL": {
- "message": "NGQL",
- "description": "The label for category NGQL in sidebar docs"
+ "sidebar.docs.category.threshold": {
+ "message": "threshold",
+ "description": "The label for category threshold in sidebar docs"
},
- "sidebar.docs.category.llm": {
- "message": "Ai LLM Monitor",
- "description": "The label for category llm in sidebar docs"
+ "sidebar.docs.category.notice": {
+ "message": "notice",
+ "description": "The label for category notice in sidebar docs"
},
- "sidebar.docs.category.aiConfig": {
- "message": "Ai LLM Config",
- "description": "The label for category aiConfig in sidebar docs"
+ "sidebar.docs.category.Others": {
+ "message": "Others",
+ "description": "The label for category Others in sidebar docs"
+ },
+ "sidebar.docs.link.Install via Helm": {
+ "message": "Install via Helm",
+ "description": "The label for link Install via Helm in sidebar docs,
linking to https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
}
}
diff --git a/home/sidebars.json b/home/sidebars.json
index 2d35ce0e2..4c14bc6c3 100755
--- a/home/sidebars.json
+++ b/home/sidebars.json
@@ -1,30 +1,62 @@
{
"docs": [
+ {
+ "type": "doc",
+ "id": "introduce"
+ },
{
"type": "category",
"label": "quickstart",
"items": [
- "introduce",
- "start/quickstart",
- "start/1.6.0-update",
- "start/docker-deploy",
- "start/package-deploy",
- "start/rainbond-deploy",
{
- "type": "link",
- "label": "Install via Helm",
- "href": "https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
+ "type": "category",
+ "label": "install",
+ "items": [
+ "start/docker-deploy",
+ "start/docker-compose-deploy",
+ "start/package-deploy",
+ {
+ "type": "link",
+ "label": "Install via Helm",
+ "href":
"https://artifacthub.io/packages/helm/hertzbeat/hertzbeat";
+ }
+ ]
+ },
+ {
+ "type": "category",
+ "label": "upgrade",
+ "items": [
+ "start/1.6.0-update",
+ "start/upgrade"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "setting",
+ "items": [
+ "start/account-modify",
+ "start/custom-config"
+ ]
},
- "start/account-modify",
- "start/upgrade",
- "start/victoria-metrics-init",
- "start/iotdb-init",
- "start/tdengine-init",
- "start/influxdb-init",
- "start/postgresql-change",
- "start/mysql-change",
- "start/custom-config",
- "start/ssl-cert-practice"
+ {
+ "type": "category",
+ "label": "change-db",
+ "items": [
+ "start/victoria-metrics-init",
+ "start/iotdb-init",
+ "start/tdengine-init",
+ "start/influxdb-init",
+ "start/postgresql-change",
+ "start/mysql-change"
+ ]
+ },
+ {
+ "type": "category",
+ "label": "use-case",
+ "items": [
+ "start/ssl-cert-practice"
+ ]
+ }
]
},
{
diff --git a/home/versioned_sidebars/version-v1.4.x-sidebars.json
b/home/versioned_sidebars/version-v1.4.x-sidebars.json
index 80a8853ee..8d1841e07 100644
--- a/home/versioned_sidebars/version-v1.4.x-sidebars.json
+++ b/home/versioned_sidebars/version-v1.4.x-sidebars.json
@@ -229,7 +229,6 @@
"type": "category",
"label": "Others",
"items": [
- "others/media",
"others/developer",
"others/contributing",
"others/contact",
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
