可用性の監視の例 (API v2)

ここでは、New Relic API (v2)を使って、New Relic Alert Policies (v2)に則って可用性の監視データを取得する例を示します。

目次

有効化と無効化

New Relic の可用性の監視機能のオン/オフを切り替えたいだけの場合は、以下のショートカットコマンドを使って下さい。
${} は正しい値に置き換えてください。監視をオンにする場合は、 enable (以下の例ように)を使ってください。オフにしたい場合は、disable を使ってください。

curl https://api.newrelic.com/accounts/${ACCNTID}/applications/${APPID}/ping_targets/enable -X POST -H "X-Api-Key:${APIKEY}"

New Relic Alert Policies (v2)のさらに詳しい情報については、ダウンタイムアラートの設定を参照してください。

アプリの可用性の監視設定の取得

可用性の監視を有効にしたり無効にしたりするには、以下の情報が必要となります。

  • アラートポリシーの名前に関連付いているpolicy id
  • そのポリシーの可用性を監視するためのcondition id

この情報を見つけるには、名前またはタイプによってポリシー番号を特定するクエリを利用してください。

出力内容は以下の例のようなものとなります。最初の部分は、指定した名前の前にフィルターのタイプとその値である"application""id"またはPOLICY_ID (この例では4172となっています)が表示されています。 (この例では4172となっています)

"conditions"配列の出力内容には、"application_availability"という値の"type"があります。このすぐ上にCONDITION_ID (ここでは31512です)があります。


{
  "alert_policies": [
    {
      "id": 4172,    <---<<< POLICY_ID
      "type": "application",
      "name": "Shoe Palace",
      "enabled": true,
      "conditions": [

      ...

        {
          "id": 31512,     <---<<< CONDITION_ID
          "type": "application_availability",
          "severity": "downtime",
          "trigger_minutes": 1,
          "enabled": false
        }
        ...

可用性の監視パラメーターの再設定

POLICY_IDCONDITION_ID を使って、可用性の監視のポリシーセクションをリセットできます。以下がその例です。

  • "enabled": true もセットして、可用性の監視をオンにする。
  • "trigger_minutes" に数値(integer)(最大 10分)をセットすると、アプリケーションが応答しない場合に、アラート発行する前に待機する時間(分単位)を制御することができます。
curl -X PUT "https://api.newrelic.com/v2/alert_policies/${POLICY_ID}.xml" \
     -H "X-Api-Key:${APIKEY}" -i \
     -H 'Content-Type: application/xml' \
     -d \
'{
  "alert_policy": {
    "conditions": [
      {
        "id": ${CONDITION_ID},
        "trigger_minutes": 1,
        "enabled": false
      }
    ]
  }
}' 

さらに詳しい情報

追加のドキュメントリソースは次のとおりです。