Application Real-Time Monitoring Service:ARMS とのカスタムアラートソースの統合

クイックスタート: 最小ペイロード

接続性を確認するために、可能な限り最小のペイロードを送信します：

curl -k -H "Content-Type: application/json" -d '{
  "alertname": "test-alert",
  "severity": "P2",
  "message": "Test alert from custom source"
}' "https://alerts.aliyuncs.com/api/v1/integrations/custom/<your-api-key>"

前のステップでコピーした API キーで <your-api-key> を置き換えてください。

完全なペイロードの例

次の curl コマンドは、サーバーで TCP パケットエラーが発生するシナリオの完全なアラートイベントを送信します。ペイロードには、ネストされたメタデータと機器の配列が含まれています：

curl -k -H "Content-Type: application/json" -d '{
  "trigger-type": "network",
  "trigger-location": "cn-hangzhou",
  "trigger-severity": "MAX",
  "trigger-policy": "package errors > 5%",
  "trigger-event": "inbound tcp package errors is 20%",
  "trigger-check": "tcp package error percentage",
  "trigger-value": "20",
  "trigger-time": "1629702922000",
  "metadata": [
    {
      "agent": "SERVER",
      "ip": "141.219.XX.XX",
      "fqdn": "websrv1.damenport.org",
      "microServiceId": "ms-login-2251",
      "accountId": "1504000433993",
      "service": "login-0"
    },
    {
      "agent": "CONTAINER",
      "ip": "172.1.XX.XX",
      "fqdn": "websrv2.damenport.org",
      "microServiceId": "ms-login-2252",
      "accountId": "129930302939",
      "service": "login-1"
    }
  ],
  "equipments": [
    {
      "equipmentId": "112"
    },
    {
      "equipmentId": "113"
    }
  ]
}' "https://alerts.aliyuncs.com/api/v1/integrations/custom/<your-api-key>"

次の表に、このペイロードの主要なフィールドを示します：

次のプレースホルダーを実際の値に置き換えてください：

テストデータの送信

1. [統合詳細] ページの [イベントマッピング] セクションで、 [テストデータの送信] をクリックします。

2. [テストデータの送信] ダイアログボックスで、アラートソースから JSON ペイロードを貼り付け、 [送信] をクリックします。

   • メッセージ [アップロード済み。イベントは生成されません。元のデータに基づいてマッピングを設定してください。] が表示された場合、フィールドはまだマッピングされていません。マッピングを設定する際のリファレンスとして、生データが左側のペインに表示されます。

   • 「[アップロード済み。]」というメッセージが表示された場合、イベントは正常に報告されています。これを[アラート イベント履歴]ページで表示します。詳細については、「過去のアラート イベントを表示する」をご参照ください。

   

3. [テストデータの送信] ダイアログボックスで、 [無効化] をクリックします。

バッチ処理の設定 (オプション)

アラートデータに配列ノード (例: metadata) が含まれている場合、配列内のすべての要素をバッチとして処理できます。

1. [イベントマッピング] セクションの左側のペインで、データレコードをクリックして詳細を表示します。

2. 右側のペインの [ルートノードの選択] で、 [バッチ処理を使用] を選択し、ルートノードとして使用する配列ノードを選択します。

バッチ処理がフィールドマッピングに与える影響：

• バッチ有効 (例: ルートノードとして metadata)：すべての $.metadata[*].service の値が、ターゲットの ARMS フィールドに繰り返しマッピングされます。

• バッチ無効：特定の要素 (例: $.metadata[0].service または $.metadata[1].service) のみがターゲットフィールドにマッピングされます。

アラート復旧イベントの設定 (オプション)

復旧イベントが到着したときにアラートを自動的にクリアするには、 [アラート復旧イベントの設定] を選択し、フィールド条件を定義します。

ARMS が条件に一致するイベントを受信すると、対応するアラートを検索してクリアします。条件フィールドは、イベントのアラート重大度と同等でなければなりません。$.severity フィールドは使用できません。

たとえば、条件 {$.eventType = "resolved"} は、統合内で eventType フィールドが resolved に等しいすべてのアラートをクリアします。

ソースフィールドと ARMS アラートフィールドのマッピング

[ソースフィールドをターゲットフィールドにマッピング] セクションで、各ソースフィールドを ARMS のアラートフィールドにマッピングします。

次の表に、ARMS のアラートフィールドを示します：

マッピングメソッド

フィールドの横にあるマップアイコンをクリックして、これらのマッピングメソッドを切り替えます：

• 直接：1 つのソースフィールドを 1 つの ARMS フィールドに直接マッピングします。

• 直列：複数のソースフィールドをデリミタ (特殊文字のみ) で連結して 1 つの値にし、それを ARMS フィールドにマッピングします。たとえば、$.trigger-type と $.trigger-policy をアンダースコア (_) で結合すると network_package errors > 5% が生成され、これが alertname にマッピングされます。

• 条件: 条件に基づいてソースフィールドをマッピングします。例:

  • $.metadata[*].agent が コンテナ と等しい場合、$.metadata[*].microServiceId を ARMS の service フィールドにマッピングします。

  • もし $.metadata[*].agent が SERVER に等しい場合、$.metadata[*].service を ARMS の service フィールドにマップします。

• マッピングテーブル：ルックアップテーブルを介してソースの値を ARMS の値に変換します。severity フィールドでのみ使用されます。