IBM Cloud Logs から送信されるイベントペイロードは、 IBM Cloud Event Notifications

IBM Cloud Logs によって生成される成功イベントには、イベントのソースと詳細を特定するのに役立つ様々なフィールドが含まれています。

IBM Cloud Logs サービスによって生成されるイベントには、リソースの名前や識別子などのメタデータプロパティのみが含まれます。 APIキーやパスワードなどの機密データは、生成されるイベントには含まれません。

Event Notifications に送信されるプロパティは、イベントタイプとサブタイプによって異なる。 例えば、 StandardMoreThanAlertEvent:AlertTriggered イベントがインスタンスで発生した場合、 IBM Cloud Logs は Event Notifications に、以下の例のような通知ペイロードを送信します。

ペイロード

{
   "data": {
      "alert_definition": {
         "alert_type": "StandardMoreThanAlertEvent",
         "condition": {
            "MoreThan": {
               "condition_threshold": 1,
               "condition_timeframe": 1
            }
         },
         "description": "",
         "id": "<alert_unique_id>",
         "meta_labels": {
            "env": "prod"
         },
         "name": "<alert_name>",
         "query_statement": "_exists_:level",
         "severity": "ERROR",
         "versioned_id": "<alert_versioned_id>",
      },
      "latest_event_timestamp": 0000000000000,
      "links": {
         "edit_alert": "https://dashboard.eu-gb.logs.cloud.ibm.com/<instance_id>/#/alerts/<alert_versioned_id>",
         "view_alert": "https://dashboard.eu-gb.logs.cloud.ibm.com/<instance_id>/#/insights?id=c9fe7539-e901-4745-b3ad-29ca0ae987a0"
      },
      "log_example": {"msg":"Test Log"},
      "log_example_truncated": true,
      "meta_labels_truncated": false,
      "priority": "<alert_priority>",
      "status": "triggered"
   },
   "datacontenttype": "application/json",
   "ibmendefaultlong": "Triggered: 2024-01-01T00:00:00Z",
   "ibmendefaultshort": "ERROR - new_groupBy",
   "ibmenseverity": "info",
   "ibmensourceid": "crn:v1:bluemix:public:logs:<region>:a/<account_id>:<instance_id>::",
   "id": "997355d5-4542-47fd-9868-84cf5df71e1b_c9fe7539-e901-4745-b3ad-29ca0ae987a0",
   "notification_id": "923873c0-2b42-4d4c-a9a0-c69339b16717",
   "source": "crn:v1:bluemix:public:logs:<region>:a/<account_id>:<instance_id>::",
   "specversion": "1.0",
   "time": "2024-01-01T00:00:00.000000Z",
   "type": "com.ibm.cloud.logs.<event_type>:<event_subtype>"
}

イベント通知プロパティーについて詳しくは、以下のテーブルをご覧ください。

イベント通知ペイロード内のプロパティ
プロパティー 説明
alert_definition
  • alert_type 通知をトリガーした アラートのタイプ。
  • condition アラートがトリガーされるアラート設定。
  • description アラートの説明
  • id 発動されたアラートの一意の識別子。 これはAPIコールで使用できるのと同じIDである。
  • name 指定されたアラートの名前。
  • query_statement 指定されたアラートの Lucene 検索クエリ。
  • severity 指定されたアラートの 重大度 レベル。
  • versioned_id トリガーされたアラートのバージョン ID。 これはアラート定義が更新されたときに生成されるIDである。
latest_event_timestamp イベントが発生した日時。
links
  • edit_alert ：アラートの設定を変更するページへのリンク。
  • view_alert ：アラートの詳細を確認するページへのリンク。
priority アラートをトリガーしたコンディションの 優先度。
status 指定したアラートのステータス。
ibmendefaultshort 与えられたアラートの名前。
ibmendefaultlong アクション（トリガーまたは解決）とアラートの名前の組み合わせ。
ibmenseverity アラートの重大度。
ibmensourceid IBM Cloud Logs サービス・インスタンスを一意的に識別するクラウド・リソース名 (CRN)。
id IBM Cloud Logs が提供する識別子は、イベントを識別するものである。 IBM Cloud Logs
notification_id Event Notifications によって作成された識別子。
source IBM Cloud Logs サービス・インスタンスを一意的に識別するクラウド・リソース名 (CRN)。
time アラート通知がトリガーされる時間。
type 通知をトリガーした イベントの種類 と 、通知をトリガーしたイベントの種類 に対応する サブタイプの 組み合わせ。

データ・サイズ

イベントでは、以下の長さが適用されます

データ・サイズ
フィールド名 最大文字数
data.log_example 1000
data.alert_definition.meta_labels 400
data.alert_definition.name 100
data.alert_definition.description 100
data.alert_definition.query_statement 100

ペイロード内の各フィールドには、それぞれ特定のサイズがあります。 いずれかのフィールドが最大文字数を超過した場合、ペイロードは切り捨てられます。

以下の情報を考慮してください。

  • 文字列フィールドが最大文字数を超えた場合、文字列は切り捨てられ、省略記号（...）が追加され、内容が切り捨てられたことが示されます。

  • メタラベルは上限まで含めます。

  • メタラベルのキーと値は制限の対象となります。

  • log_exampleフィールドが最大文字数を超えた場合、ログデータの一部を含む文字列に変換され、省略を示す「...」が続きます。

  • サンプルまたはラベルが切り捨てられたことを示すために、データに以下の追加フィールドが追加されます

    log_example_truncated: このフィールドはペイロードに追加され、ログの例が切り捨てられたことを示します。

    log_example_truncated が true の場合、切り詰められたJSONは、文字列化されたJSONとして IBM Cloud Event Notifications に送られる。

    meta_labels_truncated：このフィールドは、メタデータラベルが切り捨てられたことを示すために追加されます。

カスタムテンプレート値の特殊文字

カスタムテンプレートで、ピリオド（. ）が名前に含まれる値を使用している場合は、その値を角括弧（[ ] ）で囲む必要があります。

例えば、通知に含めたい値が kubernetes.cluster_name の場合、次のような値を含める必要があります

"CloudLogs_Shared_Summary": "{{data.log_example.[kubernetes.cluster_name]}}"