InfrastructureアラートのREST API呼び出し

Infrastructure REST APIを使用して、アラート条件の追加、更新、削除、一覧表示を行います。Infrastructure UIを使用して、個別のアラート条件を管理することもできます。

InfrastructureアラートのREST API呼び出しは、APIエクスプローラーでは利用できません。

APIを使用する理由	例
一貫性	Infrastructure UIで同じ条件を毎回設定せずに、すべてのクラスタに同じ一連の条件を定義します。複数の条件をUIで個別に更新することなく、迅速に管理します。
柔軟性	任意のホストグループに対して条件を作成できます。オフラインになったホストに対する条件をいつでも無効化、あるいは削除できます。排他的なフィルタリング（たとえば、`environment NOT LIKE x`）を使用して条件を作成します。詳細については、排他的なフィルタリングに関するこの記事を参照してください。 AWS Cloud Integrationsについては、まだAWSから送信されていない属性を選択する。 `where_clause`を使用してセカンダリまたはターシャリメトリックに制限を指定することによって、複合アラート条件を作成します。 NRQLアラート条件の500ファセット制限を上回る。
信頼性	最後に条件が更新されたタイミングで監査できます。

要件

Infrastructure REST APIを使用するには、次の情報が必要です。

New Relic のアカウントをお持ちの方。お持ちでない方は Sign up for free! 。クレジットカードは不要です。
APIキー($API_KEY)
New Relicからのアラート条件に関連するpolicy_id（条件のGETリスト、またはアラートREST APIによって取得可能）
条件id（条件のGETリスト、またはInfrastructure UIで条件のURLによって取得可能）

ヒント

お使いの組織がEUデータセンターでデータをホストする場合は、EU地域のエンドポイントを使用していることを確認してください。

Infrastructure API呼び出しの使用

ここでは、Infrastructureアラート条件用の基本的なcURLコマンドとその応答についていくつか説明します。条件のタイプに応じて、コールで提供されたDATA情報は、POST（追加）とPUT（更新）コールで異なります。

dataブロックで使用される各属性の定義は、定義セクションに記載されています。

GET Infrastructure条件

Infrastructure条件のリストのGETまたは特定のInfrastructure条件のGETを行うことができます。以下は、Infrastructure条件をリストするためのヒントです。

ページ付けには、limit（ページあたりのレコード数）とoffset（スキップするレコード数）パラメーターを使用します。デフォルトで、ページあたりのレコード数は50件、offsetは0（レコードをスキップしない）から始まります。
結果を特定のポリシーに絞り込むには、policy_idを使用します。

ヒント

GETレスポンスをPUTまたはPOSTの入力用テンプレートとして使用する場合は、必ずcreated_at_epoch_millis、updated_at_epoch_millisおよびid情報を削除してください。

Infrastructure条件のリストのGET

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions?policy_id=111111"

応答には、サンプルポリシーの3つの条件のうち2つが表示されています（読みやすくするため、フォーマット・切り詰めを行っています）。

HTTP/1.1 200 OK
Content-Length: 622
Content-Type: application/json

{
   "data":[
      {
         "type":"infra_process_running",
         "name":"Java is running",
         "enabled":true,
         "where_clause":"(`hostname` LIKE '%cassandra%')",
         "id":13890,
         "created_at_epoch_millis":1490996713872,
         "updated_at_epoch_millis":1490996713872,
         "policy_id":111111,
         "comparison":"equal",
         "critical_threshold":{
            "value":0,
            "duration_minutes":6
         },
         "process_where_clause":"(`commandName` = 'java')"
      },
      {
         "created_at_epoch_millis": 1501704525462,
         "critical_threshold": {
             "duration_minutes": 5
         },
         "enabled": true,
         "filter": {
            "and": [
                {
                     "like": {
                         "fullHostname": "Production_1"
                     }
                 }
             ]
         },
         "id": 448036,
         "name": "PROD - Host Machine's Agent Not Responding ....",
         "policy_id": 98485,
         "type": "infra_host_not_reporting",
         "updated_at_epoch_millis": 1504879191220
      }
     . . . 
   ],
   "meta":{
      "limit":50,
      "offset":0,
      "total":3
   },
   "links":{}
}

50件の上限を超えたInfrastructure条件10件分のリストを取得するには：

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions?policy_id=111111&offset=50&limit=10"

特定のInfrastructure条件のGET

単一のInfrastructure条件についての情報を取得する場合：

bash

$curl -v -X GET --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions/condition-id"

応答（読みやすくするため、フォーマットしています）：

HTTP/1.1 200 OK
Content-Length: 246
Content-Type: application/json

{
   "data":{
      "type":"infra_host_not_reporting",
      "name":"demo condition",
      "enabled":false,
      "id":13887,
      "created_at_epoch_millis":1490981583580,
      "updated_at_epoch_millis":1490981583580,
      "policy_id":23635,
      "critical_threshold":{
         "duration_minutes":100
      }
   }
}

Infrastructure条件を作成（POST）する

重要

新しい条件を追加（POST）する際は、"id":を含めないでください。条件の作成時に生成されます。

Infrastructure条件を追加する際は、次の基本的なcURLコマンドを使用します。

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json'  \
>     -d '{"data":{DATA object details}}'

追加しているInfrastructure条件のタイプについては、DATAオブジェクト（-dセクション）に詳細情報を含めてください。

プロセス実行条件のAPIデータ
メトリック条件のAPIデータ
ホストのレポート停止条件のAPIデータ

Infrastructure条件を更新（PUT）する

Infrastructure条件を更新する際は、変更が必要なフィールドを含めるだけで十分です。APIは、欠落しているフィールドの既存の値を保持します。

重要

条件typeを変更する場合は、PUT を使用しないでください。代わりに、既存の条件を削除してから、新しい条件typeおよびallフィールドを使用して新しい条件を追加 (POST) します。

Infrastructure条件を更新する際は、次の基本的なcURLコマンドを使用します。更新対象の条件を指定するには、"id":を含めるようにしてください。

bash

$curl -X PUT 'https://infra-api.newrelic.com/v2/alerts/conditions/condition-id' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' \
>     -d '{"data":{DATA object details}}'

更新しているInfrastructure条件のタイプについては、DATAオブジェクト（-dセクション）に詳細情報を含めてください。

プロセス実行条件のAPIデータ
メトリック条件のAPIデータ
ホストのレポート停止条件のAPIデータ

Infrastructure条件を削除（DELETE）する

Infrastructure条件を削除する際は、以下の基本的なcURLコマンドを使用します。

bash

$curl -v -X DELETE --header "Api-Key:$API_KEY" "https://infra-api.newrelic.com/v2/alerts/conditions/condition_id"

条件のタイプ

プロセス実行条件では、プロセスの数が定義した閾値を超えるか、下回るか、または等しい場合に警告が表示されます。プロセス実行条件を追加 (POST)または更新 (PUT) するには、 APIキーを使用し、定義を参照してAPIコールの値をカスタマイズします。

例えば：

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_process_running",
$      "name":"Java is running",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "comparison":"equal",
$      "critical_threshold":{
$         "value":0,
$         "duration_minutes":6
$      },
$      "process_where_clause":"(commandName = '\''java'\'')"
$   }
$}'

重要

余分な一重引用符でwhere_clauseの周りの一重引用符をエスケープしていることに注意してください。 process_where_clause

メトリクス条件では、選択したメトリックが定義した閾値を上回った場合、下回った場合、あるいは閾値と等しくなった場合にアラートを送信します。これには以下が含まれます。

システムメトリックス
プロセスメトリックス
ネットワークメトリックス
ストレージメトリックス
クラウドインテグレーションメトリックス
メトリクス条件を追加（POST）または更新（PUT）するには、APIキーを使用し、定義を参照してAPIコールの値をカスタマイズします。
クラウドインテグレーションのアラート条件を追加もしくはアップデートする場合：
event_typeフィールドには、選択したクラウドインテグレーションサービスが生成したイベントタイプを入力してください（例：AWS EC2インテグレーションにはComputeSample）。
プロバイダー値を必要とするクラウドインテグレーションサービスでアラート条件を設定する場合（例：AWS RDSはprovider値がRdsDbInstanceもしくはRdsDbClusterのDatastoreSampleを使用しており、"integration_provider"フィールドを追加して、アラート条件がターゲットにしたサービスに適した値を使用しなくてはいけません（例："integration_provider":"RdsDbInstance"）。

select_valueフィールドでは、providerを標準的な接頭辞ストリングとする、以下の構文を用いてメトリック名を構築します。

provider.metric.aggregation_type

metric：ご利用のインテグレーションのNew Relicドキュメンテーション内に書かれたメトリック名を使用してください。
aggregation_type：Sum、Average、MinimumまたはMaximumを使用します。インテグレーションのクラウドプロバイダによるオリジナルドキュメンテーションを参照して、各メトリクスで利用可能な統計集団はどれか確認してください。

例えば：

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_metric",
$      "name":"Disk Space Condition",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "event_type":"StorageSample",
$      "select_value":"diskFreePercent",
$      "comparison":"below",
$      "critical_threshold":{
$         "value":10,
$         "duration_minutes":1,
$         "time_function":"any"
$      },
$      "warning_threshold":{
$         "value":30,
$         "duration_minutes":2,
$         "time_function":"any"
$      }
$   }
$}'

重要

余分な一重引用符で…の周りの一重引用符をエスケープしていることに注意してください。 where_clause

ホストのレポート停止条件では、ホストがレポートを停止した場合にアラートを送信します。ホストのレポート停止条件を追加（POST）または更新（PUT）するには、APIキーを使用し、定義を参照してAPIコールの値をカスタマイズします。

no_trigger_onフィールドはオプションです。 ["shutdown"]に設定すると、 Don't trigger alerts for hosts that perform a clean shutdownインフラストラクチャ条件オプションが有効になります。

例えば：

bash

$curl -X POST 'https://infra-api.newrelic.com/v2/alerts/conditions' \
>     -H "Api-Key:$API_KEY" -i -H 'Content-Type: application/json' -d \
>'{
$   "data":{
$      "type":"infra_host_not_reporting",
$      "name":"Cassandra Host Reporting Condition",
$      "enabled":true,
$      "where_clause":"(hostname LIKE '\''%cassandra%'\'')",
$      "policy_id":policy_id,
$      "critical_threshold":{
$         "duration_minutes":12,
$         "no_trigger_on": ["shutdown"]
$      }
$   }
$}'

重要

余分な一重引用符で…の周りの一重引用符をエスケープしていることに注意してください。 where_clause

定義

cURLコマンドをフォーマットする際には、必要に応じて以下の値を使用します。これらはAPI呼び出し内の表示順ではなく、アルファベット順に表示されます。

Field	Definition
`comparison` （列挙体）	Condition type: `infra_metric`, `infra_process_running` 閾値の定義に使用する値（例：`"["above", "below", "equal"]`）。
`critical_threshold` および `warning_threshold`	Condition type: すべてこのオブジェクトは、インシデントをオープンする前に閾値を識別します。 `critical_threshold`は必須です。 `warning_threshold`はオプションで、`infra_metric`条件でのみ使用できます。このオブジェクトのキーは、条件タイプによって異なります。 Condition type: `infra_metric` フォーマット： `"critical_threshold":{ "value":<number>, "duration_minutes":<integer>, "time_function":"any" or "all" },` Condition type: `infra_process_running` フォーマット： `"critical_threshold":{ "value":<integer>, "duration_minutes":<integer>, },` Condition type: `infra_host_not_reporting` フォーマット： `"critical_threshold":{ "duration_minutes":<integer>, },`
`enabled` （ブール値）	Condition type: すべて条件のオンまたはオフ（`true`または`false`）の状態を示します。
`event_type` [string])	Condition type: `infra_metric` メトリックのイベント（例：システムメトリクス、プロセスメトリクス、ストレージメトリクス、ネットワークメトリクス）。Infrastructureインテグレーションにデータを自動入力します（例：`StorageSample`または`SystemSample`）。
`filter` [string])	Condition type: すべて条件がUIで作成された場合は、`where_clause`の代わりに`filter`が表示されます。たとえば： `{and: [{is: {ec2InstanceType: "m3.medium"}}]}` 推奨事項: 新しい条件を作成するときは`where_clause`を使用します。
`id` （整数）	Condition type: すべて URL内の条件ID。 GET：この値はGETレスポンスに出力されます。 PUT：この値を`DATA`セクションに含めてください。 POST：これは`DATA`セクションに含めないようにしてください。この値は、`-X DELETE`コールに含めてください。
`integration_provider` [string])	Condition type: `infra_metric` インテグレーションのアラートの場合は、 `event_type`ではなく`integration_provider`使用します。有効な値を確認するには、クラウドサービスのNew Relicドキュメントで Find and use data セクションを確認してください。例：AWS RDS監視インテグレーションのドキュメンテーションからは、`DatastoreSample`イベントタイプを`integration_provider`値と共に使用できることが分かります。この場合、DBインスタンスでは`RdsDbInstance`、またAurora DBクラスタでは`RdsDbCluster`となります。
`name` [string])	Condition type: すべて Infrastructureのアラート条件の名前。たとえば： `"[test] process running"`
`policy_id` （整数）	Condition type: すべて条件に関連するアラートポリシーのアカウントIDに対するユニークID（例：`1234567890`）。これはポリシーのグローバルIDではありません。
`process_where_clause` [string])	Condition type: `infra_process_running` プロセスに適用したすべてのフィルタ、特にアラート条件を実行中のプロセス。このパラメーターは、こうした種類のアラート条件において必須です。例： `"commandName = '\''java'\''"`
`runbook_url` [string])	Condition type: `all` 通知に表示されるランブック URL。
`select_value` [string])	Condition type: `infra_metric` ターゲットとするメトリックを識別する属性名（例：`"cpuPercent"`、`"diskFreePercent"`、`"memoryResidentSizeBytes", or "memoryFreeBytes/memoryTotalBytes*100"`）。Infrastructureインテグレーションにデータを自動入力します（例：`diskFreePercent`）。
`type` （列挙体）	Condition type: すべて Infrastructureアラート条件のタイプ：`"infra_process_running"`、`"infra_metric"`または`"infra_host_not_reporting"`。
`violation_close_timer` （整数）	Condition type: すべて時間で表された、インシデント時間制限設定。可能な値は`0`、`1`、`2`、`4`、`8`、`12`、`24`、`48`、`72`。これにより、インシデントが自動的に終了する前にどのくらいの時間が経過するかが決まります。新たな条件については、値が示されていない場合、次のデフォルト値を使用します：すべての条件： `24 hours` 既存の条件を更新する際、値が示されていない場合、既存の値を上書きしますが、すでに開かれているインシデントには影響はありません。
`where_clause` [string])	Condition type: すべて該当する場合、使用されているすべてのInfrastructureホストフィルターを識別します。たとえば： "(`hostname` LIKE '\''%cassandra%'\'')",

この機械翻訳は、参考として提供されています。

InfrastructureアラートのREST API呼び出し

要件

ヒント

Infrastructure API呼び出しの使用

GET Infrastructure条件

ヒント

Infrastructure条件のリストのGET

例：条件一覧を入手する

特定のInfrastructure条件のGET

例：特定の条件を入手する

Infrastructure条件を作成（POST）する

重要

Infrastructure条件を更新（PUT）する

重要

例：条件を更新する（PUT）

Infrastructure条件を削除（DELETE）する

条件のタイプ

プロセス実行条件のAPIデータ

例：条件のタイプ

重要

メトリック条件のAPIデータ

例

重要

ホストレポート停止条件

例

重要

定義

`value`

`duration_minutes`

`time_function`

この機械翻訳は、参考として提供されています。

InfrastructureアラートのREST API呼び出し

要件.css-21sua1{background:none;border:none;width:0;padding:0;}

ヒント

Infrastructure API呼び出しの使用

GET Infrastructure条件

ヒント

Infrastructure条件のリストのGET

例：条件一覧を入手する

特定のInfrastructure条件のGET

例：特定の条件を入手する

Infrastructure条件を作成（POST）する

重要

Infrastructure条件を更新（PUT）する

重要

例：条件を更新する（PUT）

Infrastructure条件を削除（DELETE）する

条件のタイプ

メトリック条件のAPIデータ

ホストレポート停止条件

定義

value

duration_minutes

time_function

要件

`value`

`duration_minutes`

`time_function`