Skip to content

Commit 811a075

Browse files
MasamiYuiyinyijuntomsun28
authored
[doc] Add alert integration japanese i18 (apache#3164)
Co-authored-by: yinyijun <[email protected]> Co-authored-by: tomsun28 <[email protected]>
1 parent 9fd58ce commit 811a075

File tree

6 files changed

+221
-1
lines changed

6 files changed

+221
-1
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
> Prometheus AlertManager のアラートを HertzBeat アラートプラットフォームに送信します。
2+
3+
### Alertmanager の Webhook 設定
4+
5+
1. Alertmanager の設定ファイルで webhook を設定する。
6+
7+
```yaml
8+
receivers:
9+
- name: 'webhook'
10+
webhook_configs:
11+
- url: 'http://{hertzbeat_host}:1157/api/alerts/report/alertmanager'
12+
send_resolved: true
13+
http_config:
14+
authorization:
15+
type: 'Bearer'
16+
credentials: '{token}'
17+
```
18+
19+
- `http://{hertzbeat_host}:1157/api/alerts/report/alertmanager` は、HertzBeat の webhook URLです。
20+
- `send_resolved: true` は、アラート解決情報を送信することを意味します。
21+
- `credentials` の `{token}` はHertzBeatが提供するtokenです。
22+
23+
2. Alertmanager のサービスを再起動する。
24+
25+
### 設定の検証
26+
27+
- Prometheus AlertManager のアラートをトリガーする。
28+
- HertzBeat アラートプラットフォームでアラートデータを閲覧し、正しいか検証する。
29+
30+
### データフロー
31+
32+
```mermaid
33+
graph LR
34+
A[Prometheus Alertmanager] --> B[Webhook]
35+
B --> C[HertzBeatアラートプラットフォーム]
36+
C --> D[グループ収束]
37+
D --> E[アラート抑制]
38+
E --> F[アラームサイレンス]
39+
F --> G[アラームセンター]
40+
F --> H[メッセージ配信]
41+
```
42+
43+
### FAQ
44+
45+
- Alertmanager の設定ファイルで webhook アドレスが正しく、ネットワークが接続されていることを確認してください。
46+
- Alertmanagerのアラートがトリガーされたかどうか、またHertzBeatアラートプラットフォームに送信されたかどうかを確認してください。
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
> Prometheus ServerのAlertmanager設定でHertzBeatのサービスアドレスを設定し、HertzBeatを使用してAlertmanagerを置き換え、Prometheus Serverのアラート情報を受信および処理します。
2+
3+
### Prometheus サービスの設定
4+
5+
- Prometheusの設定ファイル prometheus.yml を編集し、HertzBeatをアラートの受信先として追加します。
6+
```yaml
7+
# Alertmanager configuration
8+
alerting:
9+
alertmanagers:
10+
- static_configs:
11+
- targets:
12+
- {hertzbeat_host}:1157
13+
authorization:
14+
type: 'Bearer'
15+
credentials: '{token}'
16+
17+
```
18+
- `{hertzbeat_host}:1157` は、HertzBeat Server のアドレスとポートです。実際の環境に合わせて設定を修正し、ネットワーク接続が確立されていることを確認してください。
19+
- `{token}` は、HertzBeat Server の認証トークンです。新しいトークンを申請した後、置き換えてください。
20+
- Prometheus Server を再起動してください。
21+
22+
## 設定の検証
23+
24+
1. Prometheus の設定が正しいことを確認し、設定を再読み込みしてください。
25+
```bash
26+
curl -X POST http://localhost:9090/-/reload
27+
```
28+
2. Prometheusアラートルールの状態を確認する。
29+
```bash
30+
curl http://localhost:9090/api/v1/rules
31+
```
32+
3. テストアラートをトリガーし、HertzBeatアラートセンターで表示を確認する 。
33+
34+
## FAQ
35+
36+
- PrometheusサーバーからHertzBeatのURLへアクセス可能であること。
37+
- Prometheusログ内にアラート送信失敗のエラーメッセージがないか確認する。
38+
- アラートルールの式が正しいことを検証する。
39+
40+
詳細情報は [Prometheusアラート設定ドキュメント](https://prometheus.io/docs/alerting/latest/configuration/) を参照してください
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
>SkyWalking のアラートを Webhook 方式で HertzBeat アラートプラットフォームに送信します。
2+
3+
### SkyWalking の設定
4+
5+
- SkyWalking 設定ファイル `alarm-settings.yml` を編集、HertzBeat をアラート受信先として設定します。
6+
```yaml
7+
hooks:
8+
webhook:
9+
default:
10+
is-default: true
11+
urls:
12+
- http://{hertzbeat_host}:1157/api/alerts/report/skywalking
13+
```
14+
- `http://{hertzbeat_host}:1157/api/alerts/report/skywalking` は、 HertzBeat が提供する Webhook インターフェースです。
15+
- SkyWalking OAP Server を再起動してください。
16+
17+
### 設定の検証
18+
19+
1. SkyWalking の設定が正しいことを確認し、設定を再読み込みしてください。
20+
2. SkyWalkingアラートルールの状態を確認する。
21+
3. テストアラートをトリガーし、HertzBeatアラートセンターで表示を確認する。
22+
23+
24+
### FAQ
25+
26+
- SkyWalkingサーバーからHertzBeatのURLへアクセス可能であること。
27+
- SkyWalkingログ内にアラート送信失敗のエラーメッセージがないか確認する。
28+
- アラートルールの式が正しいことを検証する。
29+
30+
詳細情報は [SkyWalkingアラート設定ドキュメント](https://skywalking.apache.org/docs/main/latest/en/setup/backend/backend-alarm/)

web-app/src/assets/doc/alert-integration/skywalking.zh-CN.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ hooks:
1818

1919
1. 确保 SkyWalking 配置正确并重新加载配置
2020
2. 检查 SkyWalking 告警规则状态
21-
3. 触发测试告警并在 SkyWalking 告警中心查看
21+
3. 触发测试告警并在 HertzBeat 告警中心查看
2222

2323
### 常见问题
2424

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
>TencentCloudのアラートをWebhookでHertzBeatアラートプラットフォームに送信します。
2+
3+
### テンセントクラウドアラートコールバックの設定
4+
5+
#### 通知テンプレートの設定
6+
1. [TencentCloud Observability Platform](https://console.cloud.tencent.com/monitorv2)にログインします。
7+
2. **アラート管理** > **アラート設定** > **通知テンプレート** に移動します。
8+
4. **新しい通知テンプレート** をクリックします。
9+
4. 新しい通知テンプレートページで、基本情報を入力します。
10+
5. **インターフェースコールバック** モジュールで、HertzBeat が提供する Webhook インターフェースアドレス URL を入力します。
11+
```
12+
http://{your_system_host}/api/alerts/tencent
13+
```
14+
6. 通知テンプレートを保存します。
15+
16+
#### アラートポリシーを関連付ける
17+
1. **アラートポリシー一覧画面** に移動します。
18+
2. Webhookコールバックを関連付けるアラートポリシーを選択し、ポリシー名をクリックして管理ページにアクセスします。
19+
3. 通知テンプレート設定項目で、前の手順で作成した通知テンプレートを関連付けます。
20+
4. ポリシー設定を保存します。
21+
22+
### FAQ
23+
24+
#### アラートが受信されない場合
25+
- Webhook URLがパブリックネットワークからアクセス可能か確認してください。
26+
- サーバーログにリクエスト記録があるかチェックしてください。
27+
- Tencent Cloudの通知テンプレートページでWebhookが使用可能かテストしてください。
28+
29+
#### アラートがトリガーされない場合
30+
- アラートポリシーの条件が正しく設定されていること、および通知テンプレートが関連付けられていることを確認してください 。
31+
- Tencent Cloud監視ページのアラート履歴を確認し、ポリシーがトリガーされていることを確認してください。
32+
33+
詳細情報は [TencentCloud アラート設定ドキュメント](https://cloud.tencent.com/document/product/248/50409)
34+
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
> HertzBeat は外部システムに対してAPIインターフェースを提供し、外部システムはWebhook方式でこのインターフェースを呼び出して、アラートデータをHertzBeatアラートプラットフォームにプッシュすることができます。
2+
3+
### インターフェースエンドポイント
4+
5+
`POST /api/alerts/report`
6+
7+
### リクエストヘッダ
8+
9+
- `Content-Type`: `application/json`
10+
- `Authorization`: `Bearer {token}`
11+
12+
### リクエストボディ
13+
14+
```json
15+
{
16+
"labels": {
17+
"alertname": "HighCPUUsage",
18+
"priority": "critical",
19+
"instance": "343483943"
20+
},
21+
"annotations": {
22+
"summary": "High CPU usage detected"
23+
},
24+
"content": "The CPU usage on instance 343483943 is critically high.",
25+
"status": "firing",
26+
"triggerTimes": 3,
27+
"startAt": 1736580031832,
28+
"activeAt": 1736580039832,
29+
"endAt": null
30+
}
31+
```
32+
33+
フィールド説明
34+
35+
- `labels`: アラートラベル
36+
- `alertname`: アラートルール名
37+
- `priority`: アラートレベル (warning, critical)
38+
- `instance`: アラートインスタンス
39+
- `annotations`: アラート注釈情報
40+
- `summary`: アラート概要
41+
- `description`: アラート詳細説明
42+
- `content`: アラート内容
43+
- `status`: アラートステータス (firing, resolved)
44+
- `triggerTimes`: アラートトリガー回数
45+
- `startAt`: アラート開始時間
46+
- `activeAt`: アラートアクティブ時間
47+
- `endAt`: アラート終了時間
48+
49+
50+
### 設定検証
51+
サードパーティシステムがアラートをトリガーした後、Webhookを使用してHertzBeatの `/api/alerts/report` インターフェースをコールバックし、アラートデータをHertzBeatアラートプラットフォームにプッシュします。
52+
HertzBeatアラートプラットフォームでアラートデータを処理し、アラートデータが正しいかどうかを確認します。
53+
54+
### データフロー
55+
56+
```mermaid
57+
graph LR
58+
A[外部システムのアラーム] --> B[Webhook]
59+
B --> C[HertzBeatアラートプラットフォーム]
60+
C --> D[グループ収束]
61+
D --> E[アラート抑制]
62+
E --> F[アラームサイレンス]
63+
F --> G[アラームセンター]
64+
F --> H[メッセージ配信]
65+
```
66+
67+
68+
### FAQ
69+
- HertzBeatのURLがサードパーティシステムのサーバーからアクセス可能であることを確認してください。
70+
- サードパーティシステムのログにアラート送信が成功または失敗したメッセージがないか確認してください。

0 commit comments

Comments
 (0)