REST APIエンドポイントを使用すると、ポリシーの条件を作成できます。この用語集には、条件を定義または更新するために使用できる各フィールドの名前と説明が含まれています。
RESTAPIを使用する前に
REST API は、アラートをプログラムで管理するための推奨方法ではなくなりました。 詳細については、 の API の概要をお読みください。
必須およびオプションのフィールド
APIには、次の4種類のアラート条件が含まれています。
- APM
- 外部サービス
- NRQL
- 合成モニタリング
これらのオプションのフィールドを除いて、特定の条件タイプで使用されるすべてのフィールドが必須です。
enabled
(デフォルトはfalse
)runbook_url
user_defined
フィールド定義
この用語集にリストされているすべてのフィールドが、すべての条件タイプに必要なわけではありません。フィールドを使用する必要がある条件タイプは、各説明にリストされています。
このフィールドを使用すると、条件をJVMインスタンスまたはアプリケーション全体にスコープできます。これは文字列の1つである可能性があります。
実例
応用
のために使用される:
条件
エンティティ条件
インスタンスベースおよびJVMヘルスメトリックについては、
violation_close_timer
も参照してください。
これはアラート状態のステータスであり、オプションです。デフォルトはfalse
です。
このフィールドは、メンテナンス期間またはテスト期間の条件を有効または無効にするために使用できます。
のために使用される:
- 条件
- 外部サービス条件
- NRQL条件
- 合成モニタリング条件
これは、条件で監視されるオブジェクトを識別するエンティティIDの配列です。これらは、アプリケーションID、ブラウザID、キートランザクションID、外部サービスIDなどです。
複数ある場合、これらは一連のコンマ区切りの整数として入力されます。
のために使用される:
- 条件
- 外部サービス条件
プラットフォームが最後のデータポイントを受信してから、信号が失われたと見なされるまでの待機時間(秒単位)。これは、データのタイムスタンプではなく、データが到着した時刻に基づいています。デフォルトはnullです。信号損失検出を有効にする値を追加します。
のために使用される:
- NRQL条件
true
の場合、 expiration_duration
時間内に信号が聞こえないと、現在開いているすべてのインシデントが閉じられます。
デフォルトはfalse
です。
のために使用される:
- NRQL条件
true の場合、 expiration_duration
時間内に信号がない場合、信号損失インシデントが発生します。
デフォルトはfalse
です。
のために使用される:
- NRQL条件
監視対象の外部サービスのURLです。この文字列にはプロトコルを含めることはできません。たとえば、 https://example.com
}ではなくexample.com
を使用します。
のために使用される:
- 外部サービス条件
metricフィールドは 3 つの集計カテゴリに使用されます。 使用可能な正確な引数は、 typeフィールドの設定によって異なります。 これらは、集計タイプフィールドに従って以下にリストされます。
typeフィールドに指定された値によって、指定できる id が制御されます。 タイプフィールドとそれに対応する使用可能なparameter名を次の表に示します。 指定できるのは 1 つだけです。
| パラメータ |
---|---|
apm_app_metric |
|
apm_kt_metric |
|
browser_metric |
|
browser_metric_baseline |
|
mobile_metric |
|
typeフィールドに指定された値によって、指定できる id が制御されます。 タイプフィールドとそれに対応する使用可能なparameter名を次の表に示します。 指定できるのは 1 つだけです。
| パラメータ |
---|---|
apm_external_service |
|
apm_app_metric_baseline |
|
mobile_external_service |
|
これは、アラートを出すための合成モニタリングのGUIDです。
のために使用される:
- 合成モニタリング条件
これは、NRQL条件の一部としてモニターにアラートを出すNRQLクエリです。
のために使用される:
- NRQL条件
aggregation_delay
またはaggregation_timer
のいずれかを含むaggregation_method
を優先して非推奨になりました。これは、指定されたNRQLクエリを評価する時間枠(分単位)です。since_value
は1
と20
の間にある必要があります。
のために使用される:
- NRQL条件
集計ウィンドウがデータでいっぱいになるまでの待機時間(秒単位)。CADENCEまたはEVENT_FLOW aggregation_method
タイプを使用する場合に必要です。 デフォルトは120 secondsです。
イベントフローおよびケイデンス集計メソッドで使用されます。
のために使用される:
- NRQL条件
New Relicは、データをウィンドウに集計し、現在のウィンドウが終了し、次のウィンドウがいつ開始するかを決定する必要があります。aggregation_method
は、特定の集計ウィンドウのすべてのデータのタイミングを通知するロジックです。ウィンドウが閉じると、データは1つのポイントに集計され、閾値に対して評価されます。
このフィールドはオプションです。次の3つの値のいずれかを指定できます。
EVENT_FLOW
:(デフォルト)各集計ウィンドウは、独自の遅延設定を過ぎたタイムスタンプの到着を確認し始めるまで待機します。これが発生すると、データが公開されます。到着するデータのタイムスタンプに依存しているため、実時間は関係ありません。頻繁に発生し、イベントの広がりが少ない(スループットメトリックが高い)ソースに最適です。CADENCE
:各評価ウィンドウがaggregation_delay
設定と同じだけ待機する、ウォールクロックタイムをタイマーとして使用する従来のNew Relicロジック。このオプションを使用する場合はaggregation_delay
が必須です。到着が遅すぎるデータはドロップされ、誤ったアラートが発生することがあります。EVENT_TIMER
:各集計ウィンドウにはタイマーがあり、aggregation_timer
値に設定されています。タイマーは、その集計ウィンドウに最初のデータポイントが表示されるとすぐに実行を開始します(データポイントのタイムスタンプに基づく)。aggregation_timer
は、そのウィンドウに到着する新しいデータポイントごとにリセットされます。aggregation_timer
が0に達すると、集計ウィンドウが公開されます。クラウド統合やまれなエラーログなど、まばらでバッチ処理されたデータに最適です。デフォルトはEvent flowです。
のために使用される:
NRQL条件
バッチ全体が処理されるように、各データ ポイントを受信した後待機する秒数。 EVENT_TIMER
aggregation_method
タイプを使用する場合は必須です。 デフォルトは60 secondsです。
のために使用される:
- NRQL条件
ストリーミングアラートは、NRQLクエリで関数を実行する前に、特定の時間にデータを収集します。これらの時間枠はカスタマイズ可能です。
データ ポイントはタイムスタンプに基づいてまとめて収集され、バッチとして報告されます。カスタマイズ可能な集約ウィンドウにより、柔軟性が向上し、不規則なデータ ポイントまたは頻度の低いデータ ポイントでアラートを出す際の誤ったインシデントが少なくなります。
UI では、 Advanced signal settingsの下にあるAggregation windowフィールドです。
デフォルトは60 secondsです。 最長6時間です。
のために使用される:
- NRQL条件
デフォルトでは、集計ウィンドウは順番にグループ化されます。これにより、1つのウィンドウが開始し、別のウィンドウが開始するたびに、スパイキーなチャートが作成される可能性があります。
slide_by
を使用してスライディングウィンドウを作成します。集約されたウィンドウをスライドさせると重なり合い、より滑らかなグラフが作成されます。slide_by
間隔は、オーバーラップの期間を設定します。
UI のAdvanced signal settingsの下で、 Use sliding window aggregationトグルをクリックしてスライディング ウィンドウを有効にします。
デフォルトは、現在のウィンドウ期間に基づいています。slide_by
間隔は、集計ウィンドウの期間に均等に分割する必要があります。slide_by
間隔もウィンドウ期間より短くする必要があります。
aggregation_delay
またはaggregation_timer
のいずれかを含むaggregation_method
が推奨されません。 オフセットは、各集計ウィンドウを評価する前に遅延データを待機する時間です。 待つ時間が長くなるほど、より正確な信号が得られますが、レイテンシが増加します。 デフォルトは3 aggregation windowsです。
のために使用される:
- NRQL条件
散発的なデータの場合、ギャップ(空のウィンドウ)を合成データで埋めることで、誤ったアラートを回避できます。
none
: (デフォルト) 空の集計ウィンドウでアクションを実行したくない場合は、これを使用します。評価時に、集計ウィンドウが空になると、しきい値期間タイマーがリセットされます。たとえば、すべての集計ウィンドウに 5 分間しきい値を超えるデータ ポイントがなければならないという条件があり、5 つの集計ウィンドウのうち 1 つが空の場合、その条件ではインシデントは開始されません。static
: 評価される前に、空の集計ウィンドウにカスタムの静的値を挿入する場合は、これを使用します。このオプションには、使用する静的値を指定する追加の必須パラメータfillValue
があります。これのデフォルトは 0 です。last_value
:これを使用して、評価が行われる前に最後に表示された値を挿入します。最後に見た値の状態を2時間維持します。UI では、 Advanced signal settingsの下にあるFill data gaps withフィールドです。
のために使用される:
NRQL条件
これは、 fill_option
カスタム値によって使用される値です。デフォルトは0
です。
のために使用される:
- NRQL条件
これにより、イベントをトリガーするためにvalue_functionとterms[threshold]の値の間でどのような比較が使用されるかが決まります。 で κ を追加する ときに選択した操作に対応します。UI次のいずれかの文字列である必要があります。
その上
above_or_equals(NRQL条件のみ)
下
below_or_equals(NRQL条件のみ)
同等
not_equals(NRQL条件のみ)
のために使用される:
条件
外部サービス条件
NRQL条件
これは、UIで条件のしきい値を設定するときに選択された重大度レベルに対応します。これは、次の文字列のいずれかである必要があります。
致命的
警告
のために使用される:
条件
外部サービス条件
NRQL条件
これは、イベントをトリガーするためにvalue_functionをterms[operator]と比較する必要がある閾値です。 これはUI 、閾値値を追加する ときに で指定された数値に対応します。
これは数値であり、0(ゼロ)以上である必要があります。
のために使用される:
- 条件
- 外部サービス条件
- NRQL条件
これは、しきい値を追加するときにUIで行われる設定に対応します。選択肢は次のとおりです。
すべて(UIの
for at least
に対応)any(UIの
at least once in
に対応)のために使用される:
条件
外部サービス条件
NRQL条件
これは、集計に使用されるメトリックのタイプを定義します。 メトリクスフィールドに許容されるコンテンツは、選択されたtype値によって異なります。
2つの製品カテゴリがあります:
このカテゴリでは、 typeアラート条件のタイプを示す次の文字列のいずれかに設定されます。
| 使用する |
---|---|
apm_app_metric | アプリケーション メトリックは集計をトリガーします。 |
apm_app_metric_baseline | APM アプリケーション メトリックはアラートをトリガーします (異常しきい値を使用)。 |
apm_kt_metric | APMキートランザクションメトリックはアラートをトリガーします。 |
browser_metric | ブラウザメトリックはアラートをトリガーします。 |
browser_metric_baseline | ブラウザ メトリックはアラートをトリガーします (異常しきい値を使用)。 |
mobile_metric | モバイルメトリックはアラートをトリガーします。 |
のために使用される:
- 条件
このカテゴリでは、 type外部サービス条件のタイプを示す次の文字列のいずれかに設定されます。
| 使用する |
---|---|
apm_external_service | APM外部メトリックはアラートをトリガーします。 |
mobile_external_service | モバイル外部メトリックはアラートをトリガーします。 |
のために使用される:
- 外部サービス条件
これは、イベントをトリガーするかどうかを決定するために使用される、ユーザー定義のカスタムmetricの名前です。
インシデントをトリガーする必要があるかどうかを評価するとき、メトリックに関連付けられたuser_defined[value_function]がterms[threshold]値と比較されます。 比較は、 terms[operator]で定義された演算子を使用して実行されます。
のために使用される:
- 条件
- 外部サービス条件
- 合成モニタリング条件
これは、 user_defined[metric]で指定された輸出メトリックから取得された数値です。
インシデントをトリガーするかどうかを評価するときに、 terms[threshold]値と比較されます。 比較は、 terms[operator]で定義された演算子を使用して実行されます。
次の値関数のいずれかを指定する必要があります。
平均
分
最大
合計
サンプルサイズ
のために使用される:
条件
NRQL条件に使用する場合、オプションは次のとおりです。
- single_value(条件は各クエリの戻り値に基づいて評価されます)
- sum(条件は、指定された期間における各クエリの戻り値の合計に基づいて評価されます)
指定した秒数が経過したら、インスタンス ベースのインシデントを自動的に閉じるために使用します。
デフォルトは259,200 seconds (3日間)です。 最長30日間です。
のために使用される:
- 立地条件
- NRQL条件
指定された時間数が経過した後に、JVM 健全性メトリック インシデントを含むインスタンス ベースのインシデントを自動的に閉じるために使用します。1 ~ 720 時間の範囲にする必要があります。デフォルトは 72 時間です。
のために使用される:
apm_app_metric
(condition_scope
をinstance
に設定)apm_jvm_metric