アプリケーションIDとメトリックデータの一覧 (API v2)

ここでは、アプリケーションIDAPIキーを New Relic REST API (v2) に指定して、メトリック名と平均の取得する方法について説明します。また、異なる期間を表示します。

注: データを取得したときに返される値は、指定した期間とデータの保存方法によって異なるかもしれません。詳しくは、メトリックデータの抽出をご覧ください。

目次

全アプリケーションIDの表示

ヒント: New Relic の REST API Explorer を使って、この例と同じ情報を取得したい場合は、アプリのメトリックデータの抽出 (Explorer)をご覧ください。

全アプリケーションIDの一覧を表示する方法は、以下のとおりです。

curl -X GET 'https://api.newrelic.com/v2/applications.json' \
     -H "X-Api-Key:${APIKEY}" -i 

出力はデータ配列になります。その要素はアプリケーションとそれに関連付けられたデータです。以下は、最初の2つの要素であるアプリID 96785 (“GreatTimes Staging”)と1622 (“GreatTimes Prod”)の例です。

{
  "applications": [
    {
      "id": 96785,
      "name": "GreatTimes Staging",
      "language": "ruby",
      "health_status": "gray",
      ...
    },
    {
      "id": 1622,
      "name": "GreatTimes Prod",
      "language": "ruby",
      "health_status": "green",
      ...

名前からアプリIDを探す

名前を知っている特定のアプリのIDを表示するには、次のコマンドが使えます。$ {NAME}は実際の名前に置き換えてください。

curl -X GET 'https://api.newrelic.com/v2/applications.json' \
     -H "X-Api-Key:${API_KEY}" -i \
     -d "filter[name]=${NAME}" 

上の例で示したような出力となります。特定のアプリケーションの出力となっている点が異なります。

アプリのメトリック名の一覧

アプリケーションで利用可能なメトリック名を表示する方法は、以下のとおりです。

curl -X GET "https://api.newrelic.com/v2/applications/${APPID}/metrics.json" \
     -H "X-Api-Key:${APIKEY}' -i "

出力は、以下のような感じです。これは、多くの使用可能なメトリック名とその値の2つを示しています。このリストは長くなることがあるため、出力はページ分割されます。目当てのメトリック名が見つかるまでに、いくつかのページを見ることがあります。

{
  "metrics": [
    {
      "name": "ActiveRecord/Account/create",
      "values": [
        "average_response_time",
        "calls_per_minute",
        "call_count",
        "min_response_time",
        "max_response_time",
        "average_exclusive_time",
        "average_value",
        "requests_per_minute",
        "standard_deviation"
      ]
    },
    ...
    {
      "name": "Apdex/members/destroy",
      "values": [
        "s",
        "t",
        "f",
        "count",
        "score",
        "value",
        "threshold",
        "threshold_min"
      ]
    },
    ...

ヒント: メトリック名を知っているならば、直接その名前を指定することができます。

curl -X GET "https://api.newrelic.com/v2/applications/${APPID}/metrics.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d 'name=Controller/welcome/index' 

アプリのメトリックデータの一覧

アプリケーションで利用可能なメトリックデータを表示する方法は、以下のとおりです。

curl -X GET 'https://api.newrelic.com/v2/applications/${APPID}/metrics/data.json' \
     -H 'X-Api-Key:${APIKEY}' -i \
     -d 'names[]=EndUser&values[]=call_count&values[]=average_response_time&summarize=true' 

以下に示すように、1つの呼び出しで同じメトリック名から複数のを取得することができます。ただし、一度に 1つのメトリック名 のみ値を取得することができます。

  "metric_data": {
    "from": "2014-05-20T23:41:15+00:00",
    "to": "2014-05-21T00:11:15+00:00",
    "metrics": [
      {
        "name": "EndUser",
        "timeslices": [
          {
            "from": "2014-05-20T23:39:00+00:00",
            "to": "2014-05-21T00:08:59+00:00",
            "values": {
              "call_count": 724,
              "average_response_time": 2110
            }
          }
        ]
      }
    ]
  }

上記のコマンドを変更して、2つのメトリクス名 (例えば、 2つの "names[]=" 条件と対応する "values[]="条件)を含めたとしても、最初のメトリック名(EndUser)の値のみが返されます。

curl -X GET 'https://api.newrelic.com/v2/applications/1622/metrics/data.json' \
     -H 'X-Api-Key:30f4ec24a1f7dd9998a536b05840b17f7d42c7c1' -i \
     -d 'names[]=EndUser&names[]=EndUser/Apdex&values[]=call_count&values[]=average_response_time&values[]=score&summarize=true' 

さらに詳しい情報

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

  • API Explorer の利用 (API Explorer の UI を使って、New Relicのデータの取得や入力を行う方法について)
  • API Explorer の部品 (API Explorer の各セクションの使い方についてのクイックリファレンス)