Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[doc] update time series doc #1531

Merged
merged 1 commit into from
Feb 3, 2024
Merged
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
3 changes: 2 additions & 1 deletion home/docs/start/greptime-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Use Time Series Database GreptimeDB to Store Metrics Data (Optional)
sidebar_label: Use GreptimeDB Store Metrics
---

HertzBeat's historical data storage depends on the time series database GreptimeDB, TDengine or IoTDB, choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
We recommend VictoriaMetrics for long term support.

GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency.

Expand Down
3 changes: 2 additions & 1 deletion home/docs/start/influxdb-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Use Time Series Database InfluxDB to Store Metrics Data (Optional)
sidebar_label: Use InfluxDB Store Metrics
---

HertzBeat's historical data storage depends on the time series database InfluxDB, TDengine or IoTDB, choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
We recommend VictoriaMetrics for long term support.

TDengine is the Time Series Data Platform where developers build IoT, analytics, and cloud applications.

Expand Down
3 changes: 2 additions & 1 deletion home/docs/start/iotdb-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Use Time Series Database IoTDB to Store Metrics Data (Optional)
sidebar_label: Use IoTDB Store Metrics
---

HertzBeat's historical data storage relies on the time series database IoTDB or TDengine, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
We recommend VictoriaMetrics for long term support.

Apache IoTDB is a software system that integrates the collection, storage, management and analysis of time series data of the Internet of Things. We use it to store and analyze the historical data of monitoring metrics collected. Support V0.13+ version and V1.0.+ version.

Expand Down
17 changes: 5 additions & 12 deletions home/docs/start/package-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ sidebar_label: Install via Package
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)

Expand Down Expand Up @@ -84,16 +85,8 @@ sidebar_label: Install via Package
> 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. **Historical monitoring charts have been missing data for a long time**
> 1:Check whether you configure Tdengine or IoTDB. No configuration means no historical chart data.
> 2:Check whether Tdengine database `hertzbeat` is created.
> 3: Check whether IP account and password configuration is correct in HertzBeat's configuration file `application.yml`.
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.

5. **The historical picture of monitoring details is not displayed or has no data, and TDengine has been deployed**
> Please confirm whether the installed TDengine version is near 2.4.0.12, version 3.0 and 2.2 are not compatible.

6. **The time series database is installed and configured, but the page still displays a pop-up [Unable to provide historical chart data, please configure dependent time series database]**
> Please check if the configuration parameters are correct
> Is iot-db or td-engine enable set to true
> Note⚠️If both hertzbeat and IotDB, TDengine 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
3 changes: 2 additions & 1 deletion home/docs/start/tdengine-init.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: Use Time Series Database TDengine to Store Metrics Data (Optional)
sidebar_label: Use TDengine Store Metrics
---

HertzBeat's historical data storage depends on the time series database TDengine or IoTDB, choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
We recommend VictoriaMetrics for long term support.

TDengine is an open-source IoT time-series database, which we use to store the collected historical data of monitoring metrics. Pay attention to support ⚠️ 3.x version.

Expand Down
6 changes: 4 additions & 2 deletions home/docs/start/victoria-metrics-init.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
---
id: victoria-metrics-init
title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Optional)
title: Use Time Series Database VictoriaMetrics to Store Metrics Data (Recommended)
sidebar_label: Use VictoriaMetrics Store Metrics
---

HertzBeat's historical data storage relies on the time series database VictoriaMetrics(Recommend), IoTDB or TDengine, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
HertzBeat's historical data storage relies on the time series database, you can choose one of them to install and initialize, or not to install (note ⚠️ but it is strongly recommended to configure in the production environment)
We recommend VictoriaMetrics for long term support.


VictoriaMetrics is a fast, cost-effective and scalable monitoring solution and time series database.Recommend Version(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: 依赖时序数据库服务GreptimeDB安装初始化
sidebar_label: 使用GreptimeDB存储指标数据(可选)
---

HertzBeat的历史数据存储依赖时序数据库 GreptimeDB, 或 TDengine 或 IoTDB,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
HertzBeat的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
我们推荐使用并长期支持VictoriaMetrics

GreptimeDB is an open-source time-series database with a special focus on scalability, analytical capabilities and efficiency.
It's designed to work on infrastructure of the cloud era, and users benefit from its elasticity and commodity storage.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: 依赖时序数据库服务InfluxDB安装初始化
sidebar_label: 使用InfluxDB存储指标数据(可选)
---

HertzBeat的历史数据存储依赖时序数据库 InfluxDB, TDengine 或 IoTDB,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
HertzBeat的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
我们推荐使用并长期支持VictoriaMetrics

InfluxDB是一个由InfluxData开发的开源时序型数据库,专注于海量时序数据的高性能读、高性能写、高效存储与实时分析等。 注意支持⚠️ 1.x版本。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: 依赖时序数据库服务IoTDB安装初始化
sidebar_label: 使用IoTDB存储指标数据(可选)
---

HertzBeat的历史数据存储依赖时序数据库 IoTDB 或 TDengine,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
HertzBeat的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
我们推荐使用并长期支持VictoriaMetrics

Apache IoTDB是一体化收集、存储、管理与分析物联网时序数据的软件系统,我们使用其存储分析采集到的监控指标历史数据。支持V0.12 - V0.13版本,推荐使用V0.13.*版本。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ sidebar_label: 安装包方式部署
修改位于 `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)

Expand Down Expand Up @@ -86,6 +87,6 @@ sidebar_label: 安装包方式部署
> 二:若是安装包安装的TDengine2.3+,除了启动server外,还需执行 `systemctl start taosadapter` 启动 adapter

4. **监控历史图表长时间都一直无数据**
> 一:Tdengine或IoTDB是否配置,未配置则无历史图表数据
> 一:时序数据库是否配置,未配置则无历史图表数据
> 二:若使用了Tdengine,排查Tdengine的数据库`hertzbeat`是否创建
> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 IotDB 或 Tdengine IP账户密码等配置是否正确
> 三: HertzBeat的配置文件 `application.yml` 里面的依赖服务 时序数据库 IP账户密码等配置是否正确
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ title: 依赖时序数据库服务TDengine安装初始化
sidebar_label: 使用TDengine存储指标数据(可选)
---

HertzBeat的历史数据存储依赖时序数据库 TDengine 或 IoTDB,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
HertzBeat的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
我们推荐使用并长期支持VictoriaMetrics

TDengine是一款开源物联网时序型数据库,我们用其存储采集到的监控指标历史数据。 注意支持⚠️ 3.x版本。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: victoria-metrics-init
title: 依赖时序数据库服务VictoriaMetrics安装初始化
sidebar_label: 使用VictoriaMetrics存储指标数据(可选)
sidebar_label: 使用VictoriaMetrics存储指标数据(推荐)
---

HertzBeat的历史数据存储依赖时序数据库 VictoriaMetrics(推荐) 或 IOTDB, TDengine,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
HertzBeat的历史数据存储依赖时序数据库,任选其一安装初始化即可,也可不安装(注意⚠️但强烈建议生产环境配置)
我们推荐使用并长期支持VictoriaMetrics

VictoriaMetrics,是一个快速高效、经济并且可扩展的监控解决方案和时序数据库,兼容 Prometheus 生态。推荐版本(VictoriaMetrics:v1.95.1+, HertzBeat:v1.4.3+)

Expand Down
Loading