プラグインコンポーネントのメトリック一覧 (API v2)

New Relic の REST API を使って、 API キーに関連付けられたアカウントのプラグインのコンポーネント(インスタンス)についてのメトリック情報のリストを取得できます。そのリストは、メトリック名と値を含んでいます。以下の例にある${APIKEY}${COMPONENT_ID} のような ${} プレースホルダーは特定のIDに置き換えてください。

目次

コンポーネントのメトリック名のリスト

以下のAPIコールを使って、${COMPONENT_ID} に対応する単一コンポーネントのメトリック名のリストを取得します。

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

(JSON形式の) 出力内容の はメトリック名と値のリストとなります。

{
  "metrics": [
    {
      "name": "Agent/MetricsReported/count",    <---<<< METRIC_NAME
      "values": [
        "average_response_time",    <---<<< METRIC_VALUES listing
        "calls_per_minute",
        "call_count",
        "min_response_time",
        "max_response_time",
        "average_exclusive_time",
        "average_value",
        "requests_per_minute",
        "standard_deviation"
      ]
    },
    {
      "name": "Component/Client SSL Profiles/Current Cache Entries//Common/clientssl-insecure-compatible[entries]",
      "values": [
        "average_value",
        "total_value",
        "max_value",
        "min_value",
        "standard_deviation",
        "rate",
        "count"
      ]
    },
    ...
  }
}

特定のメトリック名と値のリスト

以下のAPIコールを使って、特定のプラグインのコンポーネントの単一メトリック名と利用可能なメトリック値を取得します。${COMPONENT_ID}と${METRIC_NAME}は適切な値に置き換えてください。

curl -X GET "https://api.newrelic.com/v2/components/${COMPONENT_ID}/metrics.json" \
     -H "X-Api-Key:${APIKEY}" -i  \
     -d "name=${METRIC_NAME}"

出力は、複数のメトリック名のAPIコール時にに表示される内容のようになります。

メトリックデータの特定

以下のAPIコールを使って、特定のコンポーネントのメトリックデータを取得します。${COMPONENT_ID}、${APIKEY}, ${METRIC_NAME}、${METRIC_VALUE} は適切な値に置き換えてください。

行いたいこと 利用するAPIコール
すべてのメトリック値を取得したい メトリック名を使って、全メトリック値を取得する

curl -X GET "https://api.newrelic.com/v2/components/${COMPONENT_ID}/metrics/data.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d "names[]=${METRIC_NAME}" 
あるメトリック値を取得したい メトリック名と値を指定する

curl -X GET "https://api.newrelic.com/v2/components/${COMPONENT_ID}/metrics/data.json" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d "names[]=${METRIC_NAME}&values[]=${METRIC_VALUE}" 
デフォルトの期間とUTCを変更したい fromtoの値を指定し、タイムゾーンを調整する。例:

curl -X GET "https://api.newrelic.com/v2/components/${COMPONENT_ID}/metrics/data.xml" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d "names[]=${METRIC_NAME}&values[]=${METRIC_VALUE}&from=2014-03-01T20:59:00+00:00&to=2014-03-01T21:59:00+00:00&summarize=true"
平均メトリックデータを返したい API コールに &summarize=true を含める。例:

curl -X GET "https://api.newrelic.com/v2/components/${COMPONENT_ID}/metrics/data.xml" \
     -H "X-Api-Key:${APIKEY}" -i \
     -d "names[]=${METRIC_NAME}&values[]=${METRIC_VALUE}&from=2014-03-01T20:59:00+00:00&to=2014-03-01T21:59:00+00:00&summarize=true"

さらに詳しい情報

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