Webhook アラート・チャネル

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "issue",
    "state": "OPEN",
    "start": 1460537793322,
    "severity": 5,
    "text": "Garbage Collection Activity High (11%)",
    "suggestion": "Tune your Garbage Collector, reduce allocation rate through code changes",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "issue",
    "state": "CLOSED",
    "start": 1460537793322,
    "end": 1460538393322,
    "severity": 5,
    "text": "Garbage Collection Activity High (11%)",
    "suggestion": "Tune your Garbage Collector, reduce allocation rate through code changes",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
    "issue": {
        "id": "G9KRvijARFw6vffuygCvl_Fyg",
        "type": "change",
        "start": 1743798954000,
        "text": "Change detected",
        "description": "The value has changed from X to Y.\n",
        "link": "https://X/#/events;eventId=G9KRvijARFw6vffuygCvl_Fyg?&snapshotId=mTraati8sdfl0H5qrEagmIRIBYoM4",
        "end": 1743798954000,
        "zone": "prod",
        "fqdn": "something.com",
        "entity": "Kubernetes Pod",
        "entityLabel": "Test",
        "tags": "docs",
        "container": "b-container"
        }
    }
}
 

{
  "issue": {
    "id": "53650436-8e35-49a3-a610-56b442ae7620",
    "type": "presence",
    "start": 1460537793322,
    "text": "online",
    "description": "Java virtual machine on Host host1.demo.com",
    "link": "https://XXXXXXX/#/?snapshotId=rjhkZXdNzegliVVEswMScGNn0YY",
    "zone": "prod",
    "fqdn": "host1.demo.com",
    "entity": "jvm",
    "entityLabel": "Test jvm",
    "tags": "production, documents, elasticsearch",
    "container": "test-container"
  }
}
 

{
    "issue": {
        "id": "ah7cCh99TjGqnZJ4UL-uZHA",
        "type": "monitoringIssue",
        "state": "OPEN",
        "start": 1743798151988,
        "severity": 5,
        "text": "Monitoring issue: nodejs_collector_not_installed",
        "suggestion": "Our Agent observed a problem with monitoring the linked process.",
        "link": "https://XX/#/events;eventId=ah7cCh99TjGqnZJ4UL-uZHA?&snapshotId=UhgAKBptVGeu04DsagNGU",
        "zone": "ava",
        "fqdn": "cool.fyre.ibm.com",
        "entity": "Process",
        "entityLabel": "node  (7532267)",
        "tags": "proc",
        "container": "c-container"
    }
}
 

一部の Webhook 連携機能では、このセクションで追加できるヘッダーの指定が必要となります。 例えば、AWS API Gateway 用の API トークンの追加などです。

HTTPAuthorization リクエストヘッダーを手動で指定する代わりに、Webhook（ URL ）経由で HTTP の基本認証を使用することもできます。 ホスト名の先 password 頭に および を username 付加する（例： https://username:password@webhookurl.com ）、認証情報は自動的に Base64-encoded として取得され、以下の HTTP ヘッダー値として提供されます：

Authorization: Basic <base64 encoded credentials>
 

変換式はアラートチャネルレベルでグローバルに適用され、そのチャネルを通じて送信されるすべてのアラートに影響します。 以下の指針を検討します。

• アラートごとの変換 ：アラートごとに異なる変換が必要な場合は、複数のWebhookアラートチャネルを作成し、それぞれに独自の変換式を設定してください。
• エラー処理 ：無効なJSONata式により、アラートの配信に失敗する可能性があります。 設定を作成する前に「 テストチャンネル 」ボタンを使用し、式が有効であることを確認するとともに、NULL値や欠損値が想定される場合に適切に対処してください。

JSONata は、JSON データに対して照会と変換を行うための軽量の言語です。 JSONataの構文に関する詳細については、 JSONataのドキュメントを参照してください。

変換機能付きのWebhookアラートチャネルを作成するには、エンド POST /api/events/settings/alertingChannels ポイントへの API リクエストにオプションの transformationExpression フィールドを含めてください。 この transformationExpression フィールドは、次の例に示すように、JSONataの構文に従う必要があります。 API の詳細については、 Instana OpenAPI specification をご覧ください。

{
    "transformationExpression": "{\"issue\": $merge([issue, {\"metricNames\": issue.text}])}",
    "headers": [],
    "rbacTags": [],
    "webhookUrls": [
        "https://webhook.example.com/endpoint"
    ],
    "kind": "WEB_HOOK",
    "name": "Transformed Webhook",
    "oauthEnabled": false
}
 

Instana のバックエンドは、 AWS および Google Cloud のサーバーからリクエストを送信しています。 そのため、JavaScript ファイルとソース・マップ・ファイルがインターネットから一般的にアクセス可能であることが重要です。 また、バックエンドで TLS の設定が正しく機能しており、 完全な証明書チェーンが構成されていることを確認してください。 SSL Labs/Qualysが提供する無料の「 SSL 」テストを利用するか、以下のコマンドを実行することで、 TLS に関する問題の有無を確認できます：

openssl s_client -showcerts -connect {{YOUR_DOMAIN_HERE}}:443