Skip to content

Commit

Permalink
update hertzbeat upgrade help doc (#1294)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsun28 committed Jan 16, 2024
1 parent 46a77a1 commit cb440e9
Show file tree
Hide file tree
Showing 11 changed files with 63 additions and 12 deletions.
1 change: 1 addition & 0 deletions home/docs/help/issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ sidebar_label: Common issues
The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。
> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened.
> When you install HertzBeat via DockerDocker root is enabled by default. No such problem.
> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address
4. If the history chart on the monitoring page is not displayed,popup [please configure dependency service on TDengine time series database]
> As shown in the popup window,the premise of history chart display is that you need install and configure hertzbeat's dependency service - TDengine database.
Expand Down
8 changes: 8 additions & 0 deletions home/docs/help/ping.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ keywords: [open source monitoring tool, open source network monitoring tool, mon
| ----------- | ----------- | ----------- |
| responseTime | ms | Website response time |


### Common Problem

1. Ping connectivity monitoring exception when installing hertzbeat for package deployment.
The hertzbeat installed and deployed by the installation package is not available for ping connectivity monitoring, but local direct ping is available 。
> The deployment of the installation package requires configuring the root permission of the Java virtual machine to start hertzbeat to use ICMP. If the root permission is not enabled, judge whether port 7 of telnet opposite end is opened.
> When you install HertzBeat via DockerDocker root is enabled by default. No such problem.
> See https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address
23 changes: 18 additions & 5 deletions home/docs/start/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,38 @@ title: HertzBeat New Version Upgrade
sidebar_label: Version Upgrade Guide
---

**HertzBeat Release Version List**

- [Github Release](https://github.com/dromara/hertzbeat/releases)
- [Gitee Release](https://gitee.com/dromara/hertzbeat/releases)
- [DockerHub Release](https://hub.docker.com/r/tancloud/hertzbeat/tags)
- [Docker quay.io Release](https://quay.io/repository/tancloud/hertzbeat?tab=tags)

HertzBeat's metadata information is stored in H2 or Mysql, PostgreSQL relational databases, and the collected indicator data is stored in time series databases such as TDengine and IotDB.

**You need to save and back up the data files of the database before upgrading**
**You need to save and back up the data files of the database and monitoring templates yml files before upgrading**


### For Docker Deploy
### Upgrade For Docker Deploy

1. If using the built-in default H2 database
1. If using custom monitoring templates
- Need to back up docker templates directory `docker cp hertzbeat:/opt/hertzbeat/define ./define` in the container `/opt/hertzbeat/define`
- `docker cp hertzbeat:/opt/hertzbeat/define ./define`
- And mount the template define directory when docker start `-v $(pwd)/define:/opt/hertzbeat/define`
- `-v $(pwd)/define:/opt/hertzbeat/define`

2. If using the built-in default H2 database
- Need to mount or back up `-v $(pwd)/data:/opt/hertzbeat/data` database file directory in the container `/opt/hertzbeat/data`
- Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image
- Refer to [Docker installation of HertzBeat] (docker-deploy) to create a new container using a new image. Note that the database file directory needs to be mounted `-v $(pwd)/data:/opt/hertzbeat/data`

2. If using external relational database Mysql, PostgreSQL
3. If using external relational database Mysql, PostgreSQL
- No need to mount the database file directory in the backup container
- Stop and delete the container, delete the local HertzBeat docker image, and pull the new version image
- Refer to [Docker installation HertzBeat] (docker-deploy) to create a new container using the new image, and configure the database connection in `application.yml`


### For Package Deploy
### Upgrade For Package Deploy

1. If using the built-in default H2 database
- Back up the database file directory under the installation package `/opt/hertzbeat/data`
Expand Down
2 changes: 1 addition & 1 deletion home/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ module.exports = {
announcementBar: {
id: 'github-star',
content:
'<font style="font-size: medium; font-weight: bolder">If you like HertzBeat,</font> <a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://github.com/dromara/hertzbeat">give us a star on GitHub </a> <font style="font-size: medium; font-weight: bolder"> or </font><a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://gitee.com/dromara/hertzbeat">Gitee please! </a>⭐️⭐️',
'<font style="font-size: medium; font-weight: bolder">If you like HertzBeat,</font> <a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://github.com/dromara/hertzbeat">give us a star on GitHub </a> <font style="font-size: medium; font-weight: bolder"> or </font><a target="_blank" style="font-size: medium; font-weight: bolder" rel="noopener noreferrer" href="https://gitee.com/dromara/hertzbeat">Gitee! </a>⭐️⭐️',
backgroundColor: '#7228B5',
textColor: '#fafbfc',
isCloseable: true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ sidebar_label: 常见问题
安装包安装部署的hertzbeat,对ping连通性监控不可用,但本地直接ping是可用的。
> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP,若未启用root权限则是判断telnet对端7号端口是否开通
> docker安装默认启用无此问题
> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address
4. 监控页面历史图表不显示,弹出 [无法提供历史图表数据,请配置依赖服务TDengine时序数据库]
> 如弹窗所示,历史图表展示的前提是需要安装配置hertzbeat的依赖服务 - TDengine数据库
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,11 @@ keywords: [开源监控系统, 开源网络监控, 网络PING监控]
| ----------- | ----------- | ----------- |
| responseTime | ms毫秒 | 网站响应时间 |


### 常见问题

1. 安装包部署的hertzbeat下ping连通性监控异常
安装包安装部署的hertzbeat,对ping连通性监控不可用,但本地直接ping是可用的。
> 安装包部署需要配置java虚拟机root权限启动hertzbeat从而使用ICMP,若未启用root权限则是判断telnet对端7号端口是否开通
> docker安装默认启用无此问题
> 详见 https://stackoverflow.com/questions/11506321/how-to-ping-an-ip-address
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,39 @@ title: HertzBeat 新版本更新指引
sidebar_label: 版本更新指引
---

HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据库内, 采集指标数据存储在 TDengine, IotDB 等时序数据库内。
**HertzBeat 的发布版本列表**

**升级前您需要保存备份好数据库的数据文件**
- [Github Release](https://github.com/dromara/hertzbeat/releases)
- [Gitee Release](https://gitee.com/dromara/hertzbeat/releases)
- [DockerHub Release](https://hub.docker.com/r/tancloud/hertzbeat/tags)
- [Docker quay.io Release](https://quay.io/repository/tancloud/hertzbeat?tab=tags)

HertzBeat 的元数据信息保存在 H2 或 Mysql, PostgreSQL 关系型数据库内, 采集指标数据存储在 TDengine, IotDB 等时序数据库内。

### For Docker Deploy
**升级前您需要保存备份好数据库的数据文件和监控模版文件**

1. 若使用内置默认 H2 数据库


### Docker部署方式的升级

1. 若使用了自定义监控模版
- 需要备份 `docker cp hertzbeat:/opt/hertzbeat/define ./define` 当前运行 docker 容器里面的 `/opt/hertzbeat/define` 目录到当前主机下
- `docker cp hertzbeat:/opt/hertzbeat/define ./define`
- 然后在后续升级启动 docker 容器的时候需要挂载上这个 define 目录,`-v $(pwd)/define:/opt/hertzbeat/define`
- `-v $(pwd)/define:/opt/hertzbeat/define`

2. 若使用内置默认 H2 数据库
- 需挂载或备份 `-v $(pwd)/data:/opt/hertzbeat/data` 容器内的数据库文件目录 `/opt/hertzbeat/data`
- 停止并删除容器,删除本地 HertzBeat docker 镜像,拉取新版本镜像
- 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器,注意需要将数据库文件目录挂载 `-v $(pwd)/data:/opt/hertzbeat/data`

2. 若使用外置关系型数据库 Mysql, PostgreSQL
3. 若使用外置关系型数据库 Mysql, PostgreSQL
- 无需挂载备份容器内的数据库文件目录
- 停止并删除容器,删除本地 HertzBeat docker 镜像,拉取新版本镜像
- 参考 [Docker安装HertzBeat](docker-deploy) 使用新镜像创建新的容器,`application.yml`配置数据库连接即可


### For Package Deploy
### 安装包部署方式的升级

1. 若使用内置默认 H2 数据库
- 备份安装包下的数据库文件目录 `/opt/hertzbeat/data`
Expand Down
3 changes: 3 additions & 0 deletions web-app/src/app/layout/basic/widgets/user.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ import { CONSTANTS } from '../../../shared/constants';
<nz-divider nzType="vertical"></nz-divider>
<span nz-icon nzType="read"></span>
<a href="https://hertzbeat.com/docs/" target="_blank"> {{ 'about.doc' | i18n }} </a>
<nz-divider nzType="vertical"></nz-divider>
<span nz-icon nzType="cloud-download"></span>
<a href="https://hertzbeat.com/docs/start/upgrade" target="_blank"> {{ 'about.upgrade' | i18n }} </a>
<a style="float: right" href="//github.com/dromara/hertzbeat" target="_blank"> {{ 'about.star' | i18n }} </a>
<span style="float: right" nz-icon nzType="star" nzTheme="twotone"></span>
<nz-divider style="float: right" nzType="vertical"></nz-divider>
Expand Down
1 change: 1 addition & 0 deletions web-app/src/assets/i18n/en-US.json
Original file line number Diff line number Diff line change
Expand Up @@ -591,6 +591,7 @@
"about.pr": "Contribution",
"about.discuss": "Discussion",
"about.doc": "Document",
"about.upgrade": "Upgrade Guide",
"about.star": "Star",
"validation.email.required": "Please enter your email!",
"validation.email.wrong-format": "The email address is in the wrong format!",
Expand Down
1 change: 1 addition & 0 deletions web-app/src/assets/i18n/zh-CN.json
Original file line number Diff line number Diff line change
Expand Up @@ -589,6 +589,7 @@
"about.pr": "贡献代码",
"about.discuss": "讨论交流",
"about.doc": "文档中心",
"about.upgrade": "升级指引",
"about.star": "点赞支持",
"validation.email.required": "请输入邮箱地址!",
"validation.email.wrong-format": "邮箱地址格式错误!",
Expand Down
1 change: 1 addition & 0 deletions web-app/src/assets/i18n/zh-TW.json
Original file line number Diff line number Diff line change
Expand Up @@ -588,6 +588,7 @@
"about.pr": "貢獻代碼",
"about.discuss": "討論交流",
"about.doc": "文檔中心",
"about.upgrade": "升級指引",
"about.star": "點贊支持",
"validation.email.required": "請輸入郵箱地址!",
"validation.email.wrong-format": "郵箱地址格式錯誤!",
Expand Down

0 comments on commit cb440e9

Please sign in to comment.