送信
カスタム Agent チェックからイベントを送信するには、以下の event(<イベント_辞書>) 関数を使用します。
self.event(
{
"timestamp": <タイムスタンプ_エポック>,
"event_type": "<イベント名>",
"msg_title": "<タイトル>",
"msg_text": "<メッセージ>",
"aggregation_key": "<集計キー>",
"alert_type": "<アラートタイプ>",
"source_type_name": "<ソースタイプ>",
"host": "<ホスト名>",
"tags": ["<タグ>"],
"priority": "<優先度>"
}
)
イベントの辞書では、以下のキーとデータ型を使用できます。
| キー | タイプ | 必須 | 説明 |
|---|
timestamp | 整数 | はい | イベントのエポックタイムスタンプ |
event_type | 文字列 | はい | イベント名 |
msg_title | 文字列 | はい | イベントのタイトル |
msg_text | 文字列 | はい | イベントのテキスト本文 |
aggregation_key | 文字列 | いいえ | イベントを集計するために使用するキー |
alert_type | 文字列 | いいえ | error、warning、success、または info (デフォルトは info) |
source_type_name | 文字列 | いいえ | ソースタイプの名前 |
host | 文字列 | いいえ | ホスト名 |
tags | 文字列のリスト | いいえ | このイベントに関連付けられるタグのリスト |
priority | 文字列 | いいえ | イベントの優先度を指定します (normal または low)。 |
例
カスタム Agent チェックを使用して、1 つのイベントを定期的に送信する例を示します。詳細については、カスタム Agent チェックの書き方を参照してください。
Agent のコンフィギュレーションディレクトリのルートにある conf.d/ フォルダーに、ディレクトリ event_example.d/ を作成します。
event_example.d/ フォルダーに次の内容でコンフィギュレーションファイルを作成し、event_example.yaml と名付けます。
conf.d/ フォルダーから階層を 1 つ上がり、checks.d/ フォルダーに移動します。
このフォルダーに次の内容でカスタムチェックファイルを作成し、event_example.py と名付けます。
from datadog_checks.base import AgentCheck
__version__ = "1.0.0"
class MyClass(AgentCheck):
def check(self, instance):
self.event(
{
"timestamp": time.time(),
"event_type": "Error",
"msg_title": "サンプルイベント",
"msg_text": "これは Datadog から送られたサンプルのイベントです。",
"alert_type": "error",
}
)
Agent を再起動します。
検証するには、Agent の status コマンドを実行し、Checks セクションで event_example を探します。
=========
Collector
=========
Running Checks
==============
(...)
event_example (1.0.0)
---------------------
Instance ID: event_example:d884b5186b651429 [OK]
Total Runs: 2
Metric Samples: Last Run: 0, Total: 0
Events: Last Run: 1, Total: 2
Service Checks: Last Run: 0, Total: 0
Average Execution Time : 0s
(...)
参考資料
