モニター API オプション

一般的なオプション

  • silenced スコープからタイムスタンプへの辞書または null。各スコープは、指定された POSIX タイムスタンプまで、または値が null の場合は無制限にミュートされます。デフォルト: null 例:

    • To mute the alert completely: {'*': null}
    • しばらくの間 role:db をミュートするには: {'role:db': 1412798116}
  • new_group_delay 新しく作成されたアプリケーションまたはコンテナを完全に開始できるようにするための、新しいグループのアラートを開始するまでの時間 (秒単位)。負でない整数である必要があります。デフォルト: 60。例: コンテナ化されたアーキテクチャーを使用している場合、評価遅延を設定すると、新しいコンテナが作成されたときにモニターのグループ化コンテナがトリガーされなくなり、最初の数分間にレイテンシーや CPU 使用率の急上昇が発生する可能性があります。

  • new_host_delay モニター結果の評価を開始する前に、ホストがブートし、アプリケーションが完全に起動するまで待つ時間 (秒単位)。負でない整数である必要があります。非推奨: 代わりに new_group_delay を使用してください

  • notify_no_data a boolean indicating whether this monitor notifies when data stops reporting. Default: False.

  • no_data_timeframe データが報告を停止してから何分後にモニターが通知を行うかを定める分数。Datadog では、メトリクスアラートの場合は少なくともモニタータイムフレームの 2 倍、サービスのチェックの場合は少なくとも 2 分に設定するよう推奨しています。省略した場合、メトリクスアラートには評価タイムフレームの 2 倍、サービスチェックには 24 時間が設定されます。

  • timeout_h データを報告していないモニターが、トリガーされた状態から自動的に回復するまでの時間数。最小許容値は 0 時間、最大許容値は 24 時間です。デフォルト: null

  • require_full_window このモニターがウィンドウ全体のデータを取得するまで評価を行わないかどうかを示すブール値。疎なメトリクスの場合は False に設定することをお勧めします。そうしないと、一部の評価がスキップされます。デフォルト: False

  • renotify_interval モニターが最後に通知してから現在のステータスを再通知するまでの分数。これは、回復していないことを再通知するだけです。デフォルト: null

  • renotify_statuses モニターが再通知する状態。デフォルト: renotify_intervalnull の場合は nullrenotify_interval が設定されている場合、デフォルトは AlertNo Data で再通知します。

  • renotify_occurrences the number of times a monitor re-notifies. It can only be set if renotify_interval is set. Default: null, it renotifies without a limit.

  • escalation_message 再通知に含めるメッセージ。他の場所と同様に ‘@username’ 通知をサポートします。renotify_intervalnull の場合は適用されません。デフォルト: null

  • notify_audit タグ付けされたユーザーに、このモニターへの変更が通知されるかどうかを示すブール値。デフォルト: False

  • include_tags このモニターからの通知のタイトルに、トリガーしているタグを自動的に挿入するかどうかを示すブール値。デフォルト: True 例:

    • True: [Triggered on {host:h1}] Monitor Title
    • False: [Triggered] Monitor Title

権限オプション

  • locked このモニターへの変更を、作成者または組織管理 (org_management) 権限を持つユーザーに制限するかどうかを示すブール値。デフォルト: False非推奨: 代わりに restricted_roles を使用してください
  • restricted_roles モニターの編集が許可されているロールの UUID をリストアップした配列。モニターの編集には、モニター構成の更新、モニターの削除、任意の時間でのモニターのミュートが含まれます。ロールの UUID は、Roles API から取得することができます。restricted_roleslocked の後継です。

注: 同じモニターに lockedrestricted_roles の両方のパラメーターを設定しないでください。両方が設定された場合、より制限の強いパラメーターが適用されます。restricted_roles に設定されたロールは、locked:true よりも制限されているとみなされます。

以下の例では、lockedrestricted_roles パラメーターがどのように相互作用するかを示しています。

  • モニターが locked:false および "restricted_roles": [ "er6ec1b6-903c-15ec-8686-da7fd0960002" ] に設定されている場合、restricted_roles パラメーターが適用されます。
  • モニターが locked:true および "restricted_roles": [ "er6ec1b6-903c-15ec-8686-da7fd0960002" ] に設定されている場合、restricted_roles パラメーターが適用されます。
  • モニターに locked:true が設定され、かつ "restricted_roles" パラメーターが設定されていない場合、locked:true パラメーターが適用されます。

モニターの RBAC 設定や、モニターを固定設定からロール制限の使用へ移行する方法について、詳しくは専用ガイドをご参照ください。

異常値のオプション

これらのオプションは異常値モニターにのみ適用され、他の種類のモニターでは無視されます。

  • threshold_windows recovery_windowtrigger_window からなる辞書。

    • recovery_window 異常メトリクスがどのくらいの期間正常であればアラートから回復するかを記述します。
    • trigger_window メトリクスがどのくらいの期間異常であればアラートをトリガーするかを記述します。

例: {'threshold_windows': {'recovery_window': 'last_15m', 'trigger_window': 'last_15m'}}

メトリクスアラートのオプション

これらのオプションはメトリクスアラートにのみ適用されます。

  • thresholds しきい値タイプ別のしきい値の辞書。メトリクスアラートには criticalwarning の 2 種類のしきい値があります。Critical はクエリで定義されますが、このオプションで指定することもできます。Warning しきい値は、しきい値オプションを使用してのみ指定できます。モニターにリカバリしきい値を使用する場合は、critical_recovery 属性と warning_recovery 属性を使用します。

例: {'critical': 90, 'warning': 80, 'critical_recovery': 70, 'warning_recovery': 50}

  • evaluation_delay 評価を遅延させる時間 (秒単位)。負以外の整数です。たとえば、この値を 300 (5 分)、タイムフレームを last_5m、時刻を 7:00 に設定すると、モニターは、6:50 から 6:55 までのデータを評価します。これは、モニターが評価時に常にデータを取得できるため、AWS CloudWatch などのバックフィルされるメトリクスで役立ちます。

サービスチェックのオプション

これらのオプションはサービスのチェックにのみ適用され、他の種類のモニターでは無視されます。

  • thresholds ステータス別のしきい値の辞書。サービスのチェックは複数のしきい値を持つことができるため、直接クエリでは定義されません。

例: {'ok': 1, 'critical': 1, 'warning': 1}

ログアラートのオプション

これらのオプションはログアラートにのみ適用されます。

  • thresholds ステータス別しきい値の辞書。

例: {'ok': 1, 'critical': 1, 'warning': 1}

  • aggregation typemetricgroupBy の辞書。
    • type: countcardinalityavg の 3 タイプをサポート。
    • metric: cardinality には、ファセットの名前を使用します。average には、メトリクスの名前を使用します。count には、メトリクスとして count を入力します。
    • groupBy: グループ化するファセットの名前。

例: {"metric": "count","type": "count","groupBy": "core_service"}

  • enable_logs_sample 通知メッセージにサンプルまたは値を追加するためのブール値。デフォルト: False
PREVIEWING: Cyril-Bouchiat/add-vm-package-explorer-doc