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

[Improve] improve markdown format for MD029 #2604

Merged
merged 11 commits into from
Aug 26, 2024
2 changes: 1 addition & 1 deletion .markdownlint-cli2.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
"siblings_only": true
},
"MD025": true,
"MD029": false,
"MD029": true,
"MD033": false,
"MD036": false,
"MD040": false,
Expand Down
52 changes: 26 additions & 26 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,23 +68,23 @@ Of course, if you have a good idea, you can also propose it directly on GitHub D

1. First you need to fork your target [hertzbeat repository](https://github.com/apache/hertzbeat).
2. Then download the code locally with git command:
```shell
git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```
```shell
git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```
3. After the download is complete, please refer to the getting started guide or README file of the target repository to initialize the project.
4. Then, you can refer to the following command to submit the code:
```shell
git checkout -b a-feature-branch #Recommended
```
```shell
git checkout -b a-feature-branch #Recommended
```
5. Submit the coed as a commit, the commit message format specification required: [module name or type name]feature or bugfix or doc: custom message.
```shell
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
```
```shell
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
```
6. Push to the remote repository
```shell
git push origin a-feature-branch
```
```shell
git push origin a-feature-branch
```
7. Then you can initiate a new PR (Pull Request) on GitHub.

Please note that the title of the PR needs to conform to our spec, and write the necessary description in the PR to facilitate code review by Committers and other contributors.
Expand Down Expand Up @@ -218,23 +218,23 @@ Add WeChat account `ahertzbeat` to pull you into the WeChat group.

1. 首先您需要 Fork 目标仓库 [hertzbeat repository](https://github.com/apache/hertzbeat).
2. 然后 用git命令 将代码下载到本地:
```shell
git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```
```shell
git clone [email protected]:${YOUR_USERNAME}/hertzbeat.git #Recommended
```
3. 下载完成后,请参考目标仓库的入门指南或者 README 文件对项目进行初始化。
4. 接着,您可以参考如下命令进行代码的提交, 切换新的分支, 进行开发:
```shell
git checkout -b a-feature-branch #Recommended
```
```shell
git checkout -b a-feature-branch #Recommended
```
5. 提交 commit , commit 描述信息需要符合约定格式: [module name or type name]feature or bugfix or doc: custom message.
```shell
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
```
```shell
git add <modified file/path>
git commit -m '[docs]feature: necessary instructions' #Recommended
```
6. 推送到远程仓库
```shell
git push origin a-feature-branch
```
```shell
git push origin a-feature-branch
```
7. 然后您就可以在 GitHub 上发起新的 PR (Pull Request)。

请注意 PR 的标题需要符合我们的规范,并且在 PR 中写上必要的说明,来方便 Committer 和其他贡献者进行代码审查。
Expand Down
52 changes: 26 additions & 26 deletions home/blog/2022-09-10-ssl-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,71 +28,71 @@ gitee: <https://gitee.com/hertzbeat/hertzbeat>

2. The `docker` environment can be installed with a single command

`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat`
`docker run -d -p 1157:1157 --name hertzbeat apache/hertzbeat`

3. Installation success browser visit `localhost:1157` to start, the default account password `admin/hertzbeat

#### Monitoring SSL Certificates

1. Click Add SSL Certificate Monitor

> System Page -> Monitor Menu -> SSL Certificates -> New SSL Certificate
> System Page -> Monitor Menu -> SSL Certificates -> New SSL Certificate

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/bd53f343a5b54feab62e71458d076441~tplv-k3u1fbpfcp-zoom-1.image)

2. Configure monitoring website

> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK.
> Click OK. Note that ⚠️ will test the connectivity of the website before adding it by default, and it will add it only if the connection is successful, of course, you can also gray out the **Whether to test** button.
> Here is an example to monitor Baidu website, configure the host domain name, name, collection interval, etc. > Click OK.
> Click OK. Note that ⚠️ will test the connectivity of the website before adding it by default, and it will add it only if the connection is successful, of course, you can also gray out the **Whether to test** button.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ad1154670648413bb82c8bdeb5b13609~tplv-k3u1fbpfcp-zoom-1.image)

3. Viewing Test Indicator Data

> You can view the task status in the monitor list, and go into the monitor details to view the metrics data graphs etc.
> You can view the task status in the monitor list, and go into the monitor details to view the metrics data graphs etc.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/f874b45e909c4bb0acdd28b3fb034a61~tplv-k3u1fbpfcp-zoom-1.image)

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/ef5d7443f8c04818ae5aa28d421203be~tplv-k3u1fbpfcp-zoom-1.image)

4. Set the threshold (triggered when the certificate expires)

> System Page -> Alarms -> Alarm Thresholds -> Add Thresholds
> System Page -> Alarms -> Alarm Thresholds -> Add Thresholds

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/8d6205172d43463aa34e534477f132f1~tplv-k3u1fbpfcp-zoom-1.image)

> Configure thresholds, select SSL certificate indicator object, configure alert expression - triggered when indicator `expired` is `true`, i.e. `equals(expired, "true")` , set alert level notification template message etc.
> Configure thresholds, select SSL certificate indicator object, configure alert expression - triggered when indicator `expired` is `true`, i.e. `equals(expired, "true")` , set alert level notification template message etc.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/83d17b381d994f26a6240e01915b2001~tplv-k3u1fbpfcp-zoom-1.image)

> Associate thresholds with monitors, set which monitors this threshold should be applied to in the threshold list.
> Associate thresholds with monitors, set which monitors this threshold should be applied to in the threshold list.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/9b9063d7bcf9454387be0491fc382bd1~tplv-k3u1fbpfcp-zoom-1.image)

5. set the threshold (triggered one week before certificate expiration)

> Same as above, add a new configuration threshold, configure the alert expression - when the indicator validity timestamp `end_timestamp`, `now()` function for the current timestamp, if you configure to trigger the alert one week in advance i.e.: `end_timestamp <= (now() + 604800000)` , where `604800000` is the total time difference of 7 days. milliseconds.
> Same as above, add a new configuration threshold, configure the alert expression - when the indicator validity timestamp `end_timestamp`, `now()` function for the current timestamp, if you configure to trigger the alert one week in advance i.e.: `end_timestamp <= (now() + 604800000)` , where `604800000` is the total time difference of 7 days. milliseconds.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/0d6f837f57c247e09f668f60eff4a0ff~tplv-k3u1fbpfcp-zoom-1.image)

> Eventually you can see the triggered alarms in the alarm center.
> Eventually you can see the triggered alarms in the alarm center.

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/5a61b23127524976b2c209ce0ca6a339~tplv-k3u1fbpfcp-zoom-1.image)

6. Alarm notification (timely notification via NailWeChatFlysheet, etc.)

> Monitoring System -> Alert Notification -> Add Recipients
> Monitoring System -> Alert Notification -> Add Recipients

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/7f36956060ef410a82bbecafcbb2957f~tplv-k3u1fbpfcp-zoom-1.image)

You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc.
You can refer to the help file for the token configuration of Nail WeChat Flying Book, etc.

<https://hertzbeat.com/docs/help/alert_dingtalk>
<https://tancloud.cn/docs/help/alert_dingtalk>
<https://hertzbeat.com/docs/help/alert_dingtalk>
<https://tancloud.cn/docs/help/alert_dingtalk>

> Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured
> Alert Notification -> Add new alert notification policy -> Enable notification for the recipients you just configured

![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image)
![](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/d976343e81f843138344a039f3aff8a3~tplv-k3u1fbpfcp-zoom-1.image)

7. OK When the threshold is triggered, we can receive the corresponding alarm message, if there is no notification, you can also view the alarm information in the alarm center.

Expand Down
56 changes: 28 additions & 28 deletions home/blog/2023-01-05-monitor-iotdb.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,44 +31,44 @@ tags: [opensource, practice]

1. The metric collection is disabled by default, you need to modify the parameters in `conf/iotdb-metric.yml` first, then restart the server

```
# Whether to start the monitoring module, the default is false
enableMetric: true

# Data provision method, externally provide metrics data through jmx and prometheus protocol, optional parameters: [JMX, PROMETHEUS, IOTDB], IOTDB is closed by default.
metricReporterList:
- JMX
- PROMETHEUS
```
```yaml
# Whether to start the monitoring module, the default is false
enableMetric: true
# Data provision method, externally provide metrics data through jmx and prometheus protocol, optional parameters: [JMX, PROMETHEUS, IOTDB], IOTDB is closed by default.
metricReporterList:
- JMX
- PROMETHEUS
```

2. Restart IoTDB, open a browser or use curl to access <http://ip:9091/metrics>, and you can see the metric data.

#### 2. Add IoTDB monitoring on the HertzBeat monitoring page

1. Click Add IoTDB Monitoring

Path: Menu -> Database Monitoring -> IoTDB Monitoring -> Add IoTDB Monitoring
Path: Menu -> Database Monitoring -> IoTDB Monitoring -> Add IoTDB Monitoring

![hertzbeat](/img/blog/monitor-iotdb-1.png)
![hertzbeat](/img/blog/monitor-iotdb-1.png)

2. Configure the parameters required for monitoring IoTDB

Fill in the IoTDB **service IP** and **monitoring port** (default 9091) on the monitoring page, and finally click OK to add.
For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/iotdb/) <https://hertzbeat.com/docs/help> /iotdb/
Fill in the IoTDB **service IP** and **monitoring port** (default 9091) on the monitoring page, and finally click OK to add.
For other parameters such as **collection interval**, **timeout period**, etc., please refer to [Help Documentation](https://hertzbeat.com/docs/help/iotdb/) <https://hertzbeat.com/docs/help> /iotdb/

![hertzbeat](/img/blog/monitor-iotdb-2.png)
![hertzbeat](/img/blog/monitor-iotdb-2.png)

3. Complete ✅, now we have added the monitoring of IoTDB, check the monitoring list to see our added items.

![hertzbeat](/img/blog/monitor-iotdb-3.png)
![hertzbeat](/img/blog/monitor-iotdb-3.png)

4. Click **Operation**->**Monitoring Details Icon** of the monitoring list item to browse the real-time monitoring metric data of IoTDB.

![hertzbeat](/img/blog/monitor-iotdb-4.png)
![hertzbeat](/img/blog/monitor-iotdb-4.png)

5. Click **Monitoring History Details TAB** to browse IoTDB's historical monitoring metric data chart📈.

![hertzbeat](/img/blog/monitor-iotdb-5.png)
![hertzbeat](/img/blog/monitor-iotdb-5.png)

**Complete DONE! Through the above steps, it is actually two steps to sum up**

Expand All @@ -83,29 +83,29 @@ For other parameters such as **collection interval**, **timeout period**, etc.,

1. Configure a threshold alarm for an important metric

Path: Menu -> Alarm Threshold -> Add Threshold
Path: Menu -> Alarm Threshold -> Add Threshold

- Select the configured metric object. IotDB monitors many metrics, one of which is related to the status of the node `cluster_node_status` -> `status` (node status, 1=online 2=offline).
- Here we configure to send an alarm when the metric `status==2`, the alarm level is **Critical Alarm**, which is triggered once, as shown in the figure below.
- Select the configured metric object. IotDB monitors many metrics, one of which is related to the status of the node `cluster_node_status` -> `status` (node status, 1=online 2=offline).
- Here we configure to send an alarm when the metric `status==2`, the alarm level is **Critical Alarm**, which is triggered once, as shown in the figure below.

![hertzbeat](/img/blog/monitor-iotdb-6.png)
![hertzbeat](/img/blog/monitor-iotdb-6.png)

2. Add message notification recipients

Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient
Path: Menu -> Alarm Notification -> Alarm Recipient -> Add New Recipient

Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example.
Message notification methods support **email, DingTalk, WeChat Work, Feishu, WebHook, SMS**, etc. Here we take the commonly used DingTalk as an example.

- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) <https://hertzbeat.com/docs/help/alert_dingtalk> to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value.
- Configure the receiver parameters in HertzBeat as follows.
- Refer to this [Help Documentation](https://hertzbeat.com/docs/help/alert_dingtalk) <https://hertzbeat.com/docs/help/alert_dingtalk> to configure the robot on DingTalk and set the security custom keyword `HertzBeat`, get the corresponding `access_token` value.
- Configure the receiver parameters in HertzBeat as follows.

【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】
【Alarm Notification】->【New Recipient】->【Select DingTalk Robot Notification Method】->【Set DingTalk Robot ACCESS_TOKEN】->【OK】

![hertzbeat](/img/blog/alert-notice-1.png)
![hertzbeat](/img/blog/alert-notice-1.png)

3. Configure the associated alarm notification strategy ⚠️ [Add notification strategy] -> [Associate the recipient just set] -> [OK]

![hertzbeat](/img/blog/alert-notice-2.png)
![hertzbeat](/img/blog/alert-notice-2.png)

### Finished, now wait for the warning message to come. ding ding ding ding

Expand Down
Loading
Loading