Soracom

Users

ドキュメント
Home ドキュメント SORACOM Lagoon 3

Webhook で送信される JSON

Webhook で送信される JSON は以下のとおりです。

JSON の例:

{
    "receiver": "",
    "status": "firing",
    "alerts": [
        {
            "status": "firing",
            "labels": {
                "alertname": "TestAlert",
                "instance": "Grafana"
            },
            "annotations": {
                "summary": "Notification test"
            },
            "startsAt": "2024-02-08T08:30:51.525784404Z",
            "endsAt": "0001-01-01T00:00:00Z",
            "generatorURL": "https://g-v3.lagoon.soracom.io/alerting/xxxxx",
            "fingerprint": "57c6d9296de2ad39",
            "silenceURL": "https://g-v3.lagoon.soracom.io/alerting/silence/new?xxxxx",
            "dashboardURL": "",
            "panelURL": "",
            "values": null,
            "valueString": "[ metric='foo' labels={instance=bar} value=10 ]"
        }
    ],
    "groupLabels": {},
    "commonLabels": {
        "alertname": "TestAlert",
        "instance": "Grafana"
    },
    "commonAnnotations": {
        "summary": "Notification test"
    },
    "externalURL": "https://g-v3.lagoon.soracom.io/",
    "version": "1",
    "groupKey": "{alertname=\"TestAlert\", instance=\"Grafana\"}2024-02-08 08:30:51.525784404 +0000 UTC m=+387996.549838463",
    "truncatedAlerts": 0,
    "orgId": 218,
    "title": "[FIRING:1]  (TestAlert Grafana)",
    "state": "alerting",
    "message": "**Firing**\n\nValue: [no value]\nLabels:\n - alertname = TestAlert\n - instance = Grafana\nAnnotations:\n - summary = Notification test\nSilence: https://g-v3.lagoon.soracom.io/alerting/silence/new?xxxxx\n"
}
プロパティ説明
receiverAlert rule の名前。
statusfiring または resolved
alerts[]Alert の情報。1 つの Webhook に複数の Alert が含まれることがあります。
alerts[].statusfiring または resolved
alerts[].labelsAlert rule に設定した Labels。別途、alertnamegrafana_folder が設定されます。
alerts[].annotationAlert rule の [Summary and annotations] に指定した情報。
alerts[].startsAtalerts[].statusfiring になった時刻 (UTC)。
alerts[].endsAtalerts[].statusresolved の場合に、resolved になった時刻 (UTC)。
alerts[].generatorURLAlert rule を確認するための URL。
alerts[].fingerprintalerts[].labels のフィンガープリント (ハッシュ値)。alerts[].labels が同一の場合は、フィンガープリントも同一です。
alerts[].silenceURLAlert rule の Silence を設定するための Add silence 画面を表示するための URL。
alerts[].dashboardURLAlert rule に関連付けられた Dashboard の URL。Alert rule に Dashboard を関連付けている場合に設定されます。
alerts[].panelURLAlert rule に関連付けられた Panel の URL。Alert rule に Dashboard と Panel を関連付けている場合に設定されます。
alerts[].valuesAlert rule で参照している系列の値。Webhook が送信されることが決定されたときの値が設定されます。
alerts[].valueStringalerts[].values を文字列に変換したもの。
groupLabels.alertnameAlert rule の名前。
groupLabels.grafana_folderAlert rule が保存されいてる Folder の名前。
commonLabelsAlert rule に設定した Labels。別途、alertnamegrafana_folder が設定されます。
commonAnnotationsAlert rule の [Summary and annotations] に指定した情報。
externalURLLagoon 3 の Lagoon コンソールの URL。
version1
groupKeyAlert group を決定することになった [Group by] に関する情報。
truncatedAlerts通知されなかった Alert の数。
orgIdお客様の Lagoon 3 の ID (SORACOM 管理用の ID)。
title通知の件名。
statealerting または ok。Alert の状態を示します。
message通知メッセージ。

詳しくは、Grafana documentation の Configure the webhook notifier (英語) を参照してください。