This is an automated email from the ASF dual-hosted git repository.
gongchao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hertzbeat.git
The following commit(s) were added to refs/heads/master by this push:
new 811a07553b [doc] Add alert integration japanese i18 (#3164)
811a07553b is described below
commit 811a07553b40595632a62b622098000db6611a3d
Author: Sherlock Yin <[email protected]>
AuthorDate: Sat Mar 22 14:16:28 2025 +0800
[doc] Add alert integration japanese i18 (#3164)
Co-authored-by: yinyijun <[email protected]>
Co-authored-by: tomsun28 <[email protected]>
---
.../doc/alert-integration/alertmanager.ja-JP.md | 46 ++++++++++++++
.../doc/alert-integration/prometheus.ja-JP.md | 40 +++++++++++++
.../doc/alert-integration/skywalking.ja-JP.md | 30 ++++++++++
.../doc/alert-integration/skywalking.zh-CN.md | 2 +-
.../assets/doc/alert-integration/tencent.ja-JP.md | 34 +++++++++++
.../assets/doc/alert-integration/webhook.ja-JP.md | 70 ++++++++++++++++++++++
6 files changed, 221 insertions(+), 1 deletion(-)
diff --git a/web-app/src/assets/doc/alert-integration/alertmanager.ja-JP.md
b/web-app/src/assets/doc/alert-integration/alertmanager.ja-JP.md
new file mode 100644
index 0000000000..5d04271f63
--- /dev/null
+++ b/web-app/src/assets/doc/alert-integration/alertmanager.ja-JP.md
@@ -0,0 +1,46 @@
+> Prometheus AlertManager のアラートを HertzBeat アラートプラットフォームに送信します。
+
+### Alertmanager の Webhook 設定
+
+1. Alertmanager の設定ファイルで webhook を設定する。
+
+```yaml
+receivers:
+ - name: 'webhook'
+ webhook_configs:
+ - url: 'http://{hertzbeat_host}:1157/api/alerts/report/alertmanager'
+ send_resolved: true
+ http_config:
+ authorization:
+ type: 'Bearer'
+ credentials: '{token}'
+```
+
+- `http://{hertzbeat_host}:1157/api/alerts/report/alertmanager` は、HertzBeat の
webhook URLです。
+- `send_resolved: true` は、アラート解決情報を送信することを意味します。
+- `credentials` の `{token}` はHertzBeatが提供するtokenです。
+
+2. Alertmanager のサービスを再起動する。
+
+### 設定の検証
+
+- Prometheus AlertManager のアラートをトリガーする。
+- HertzBeat アラートプラットフォームでアラートデータを閲覧し、正しいか検証する。
+
+### データフロー
+
+```mermaid
+graph LR
+ A[Prometheus Alertmanager] --> B[Webhook]
+ B --> C[HertzBeatアラートプラットフォーム]
+ C --> D[グループ収束]
+ D --> E[アラート抑制]
+ E --> F[アラームサイレンス]
+ F --> G[アラームセンター]
+ F --> H[メッセージ配信]
+```
+
+### FAQ
+
+- Alertmanager の設定ファイルで webhook アドレスが正しく、ネットワークが接続されていることを確認してください。
+- Alertmanagerのアラートがトリガーされたかどうか、またHertzBeatアラートプラットフォームに送信されたかどうかを確認してください。
diff --git a/web-app/src/assets/doc/alert-integration/prometheus.ja-JP.md
b/web-app/src/assets/doc/alert-integration/prometheus.ja-JP.md
new file mode 100644
index 0000000000..f3eaf8604e
--- /dev/null
+++ b/web-app/src/assets/doc/alert-integration/prometheus.ja-JP.md
@@ -0,0 +1,40 @@
+> Prometheus
ServerのAlertmanager設定でHertzBeatのサービスアドレスを設定し、HertzBeatを使用してAlertmanagerを置き換え、Prometheus
Serverのアラート情報を受信および処理します。
+
+### Prometheus サービスの設定
+
+- Prometheusの設定ファイル prometheus.yml を編集し、HertzBeatをアラートの受信先として追加します。
+```yaml
+# Alertmanager configuration
+alerting:
+ alertmanagers:
+ - static_configs:
+ - targets:
+ - {hertzbeat_host}:1157
+ authorization:
+ type: 'Bearer'
+ credentials: '{token}'
+
+```
+- `{hertzbeat_host}:1157` は、HertzBeat Server
のアドレスとポートです。実際の環境に合わせて設定を修正し、ネットワーク接続が確立されていることを確認してください。
+- `{token}` は、HertzBeat Server の認証トークンです。新しいトークンを申請した後、置き換えてください。
+- Prometheus Server を再起動してください。
+
+## 設定の検証
+
+1. Prometheus の設定が正しいことを確認し、設定を再読み込みしてください。
+ ```bash
+ curl -X POST http://localhost:9090/-/reload
+ ```
+2. Prometheusアラートルールの状態を確認する。
+ ```bash
+ curl http://localhost:9090/api/v1/rules
+ ```
+3. テストアラートをトリガーし、HertzBeatアラートセンターで表示を確認する 。
+
+## FAQ
+
+- PrometheusサーバーからHertzBeatのURLへアクセス可能であること。
+- Prometheusログ内にアラート送信失敗のエラーメッセージがないか確認する。
+- アラートルールの式が正しいことを検証する。
+
+詳細情報は
[Prometheusアラート設定ドキュメント](https://prometheus.io/docs/alerting/latest/configuration/)
を参照してください
diff --git a/web-app/src/assets/doc/alert-integration/skywalking.ja-JP.md
b/web-app/src/assets/doc/alert-integration/skywalking.ja-JP.md
new file mode 100644
index 0000000000..f160bb8be4
--- /dev/null
+++ b/web-app/src/assets/doc/alert-integration/skywalking.ja-JP.md
@@ -0,0 +1,30 @@
+>SkyWalking のアラートを Webhook 方式で HertzBeat アラートプラットフォームに送信します。
+
+### SkyWalking の設定
+
+- SkyWalking 設定ファイル `alarm-settings.yml` を編集、HertzBeat をアラート受信先として設定します。
+```yaml
+hooks:
+ webhook:
+ default:
+ is-default: true
+ urls:
+ - http://{hertzbeat_host}:1157/api/alerts/report/skywalking
+```
+- `http://{hertzbeat_host}:1157/api/alerts/report/skywalking` は、 HertzBeat
が提供する Webhook インターフェースです。
+- SkyWalking OAP Server を再起動してください。
+
+### 設定の検証
+
+1. SkyWalking の設定が正しいことを確認し、設定を再読み込みしてください。
+2. SkyWalkingアラートルールの状態を確認する。
+3. テストアラートをトリガーし、HertzBeatアラートセンターで表示を確認する。
+
+
+### FAQ
+
+- SkyWalkingサーバーからHertzBeatのURLへアクセス可能であること。
+- SkyWalkingログ内にアラート送信失敗のエラーメッセージがないか確認する。
+- アラートルールの式が正しいことを検証する。
+
+詳細情報は
[SkyWalkingアラート設定ドキュメント](https://skywalking.apache.org/docs/main/latest/en/setup/backend/backend-alarm/)
diff --git a/web-app/src/assets/doc/alert-integration/skywalking.zh-CN.md
b/web-app/src/assets/doc/alert-integration/skywalking.zh-CN.md
index 40718b253f..4b9cfb55e6 100644
--- a/web-app/src/assets/doc/alert-integration/skywalking.zh-CN.md
+++ b/web-app/src/assets/doc/alert-integration/skywalking.zh-CN.md
@@ -18,7 +18,7 @@ hooks:
1. 确保 SkyWalking 配置正确并重新加载配置
2. 检查 SkyWalking 告警规则状态
-3. 触发测试告警并在 SkyWalking 告警中心查看
+3. 触发测试告警并在 HertzBeat 告警中心查看
### 常见问题
diff --git a/web-app/src/assets/doc/alert-integration/tencent.ja-JP.md
b/web-app/src/assets/doc/alert-integration/tencent.ja-JP.md
new file mode 100644
index 0000000000..f9ea990318
--- /dev/null
+++ b/web-app/src/assets/doc/alert-integration/tencent.ja-JP.md
@@ -0,0 +1,34 @@
+>TencentCloudのアラートをWebhookでHertzBeatアラートプラットフォームに送信します。
+
+### テンセントクラウドアラートコールバックの設定
+
+#### 通知テンプレートの設定
+1. [TencentCloud Observability
Platform](https://console.cloud.tencent.com/monitorv2)にログインします。
+2. **アラート管理** > **アラート設定** > **通知テンプレート** に移動します。
+4. **新しい通知テンプレート** をクリックします。
+4. 新しい通知テンプレートページで、基本情報を入力します。
+5. **インターフェースコールバック** モジュールで、HertzBeat が提供する Webhook インターフェースアドレス URL を入力します。
+ ```
+ http://{your_system_host}/api/alerts/tencent
+ ```
+6. 通知テンプレートを保存します。
+
+#### アラートポリシーを関連付ける
+1. **アラートポリシー一覧画面** に移動します。
+2. Webhookコールバックを関連付けるアラートポリシーを選択し、ポリシー名をクリックして管理ページにアクセスします。
+3. 通知テンプレート設定項目で、前の手順で作成した通知テンプレートを関連付けます。
+4. ポリシー設定を保存します。
+
+### FAQ
+
+#### アラートが受信されない場合
+- Webhook URLがパブリックネットワークからアクセス可能か確認してください。
+- サーバーログにリクエスト記録があるかチェックしてください。
+- Tencent Cloudの通知テンプレートページでWebhookが使用可能かテストしてください。
+
+#### アラートがトリガーされない場合
+- アラートポリシーの条件が正しく設定されていること、および通知テンプレートが関連付けられていることを確認してください 。
+- Tencent Cloud監視ページのアラート履歴を確認し、ポリシーがトリガーされていることを確認してください。
+
+詳細情報は [TencentCloud
アラート設定ドキュメント](https://cloud.tencent.com/document/product/248/50409)
+
diff --git a/web-app/src/assets/doc/alert-integration/webhook.ja-JP.md
b/web-app/src/assets/doc/alert-integration/webhook.ja-JP.md
new file mode 100644
index 0000000000..d5ae83b94b
--- /dev/null
+++ b/web-app/src/assets/doc/alert-integration/webhook.ja-JP.md
@@ -0,0 +1,70 @@
+> HertzBeat
は外部システムに対してAPIインターフェースを提供し、外部システムはWebhook方式でこのインターフェースを呼び出して、アラートデータをHertzBeatアラートプラットフォームにプッシュすることができます。
+
+### インターフェースエンドポイント
+
+`POST /api/alerts/report`
+
+### リクエストヘッダ
+
+- `Content-Type`: `application/json`
+- `Authorization`: `Bearer {token}`
+
+### リクエストボディ
+
+```json
+{
+ "labels": {
+ "alertname": "HighCPUUsage",
+ "priority": "critical",
+ "instance": "343483943"
+ },
+ "annotations": {
+ "summary": "High CPU usage detected"
+ },
+ "content": "The CPU usage on instance 343483943 is critically high.",
+ "status": "firing",
+ "triggerTimes": 3,
+ "startAt": 1736580031832,
+ "activeAt": 1736580039832,
+ "endAt": null
+}
+```
+
+フィールド説明
+
+- `labels`: アラートラベル
+ - `alertname`: アラートルール名
+ - `priority`: アラートレベル (warning, critical)
+ - `instance`: アラートインスタンス
+- `annotations`: アラート注釈情報
+ - `summary`: アラート概要
+ - `description`: アラート詳細説明
+- `content`: アラート内容
+- `status`: アラートステータス (firing, resolved)
+- `triggerTimes`: アラートトリガー回数
+- `startAt`: アラート開始時間
+- `activeAt`: アラートアクティブ時間
+- `endAt`: アラート終了時間
+
+
+### 設定検証
+サードパーティシステムがアラートをトリガーした後、Webhookを使用してHertzBeatの `/api/alerts/report`
インターフェースをコールバックし、アラートデータをHertzBeatアラートプラットフォームにプッシュします。
+HertzBeatアラートプラットフォームでアラートデータを処理し、アラートデータが正しいかどうかを確認します。
+
+### データフロー
+
+```mermaid
+graph LR
+ A[外部システムのアラーム] --> B[Webhook]
+ B --> C[HertzBeatアラートプラットフォーム]
+ C --> D[グループ収束]
+ D --> E[アラート抑制]
+ E --> F[アラームサイレンス]
+ F --> G[アラームセンター]
+ F --> H[メッセージ配信]
+```
+
+
+### FAQ
+- HertzBeatのURLがサードパーティシステムのサーバーからアクセス可能であることを確認してください。
+- サードパーティシステムのログにアラート送信が成功または失敗したメッセージがないか確認してください。
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
