New RelicのGraphQL APIであるNerdGraphの概要

NerdGraphは、New Relicデータにクエリを実行して、いくつかのNew Relic機能を設定できる当社のGraphQL形式のAPIです。New Relicアカウントにサインアップし、当社のモニタリングサービスをインストールすると、NerdGraphを使い始めることができます。

NerdGraphとは

New Relicには、いくつかのAPIがあります。NerdGraphは、New Relicデータにクエリを実行して、特定の設定を実行するための推奨APIです（機能の詳細を確認する）。NerdGraphには、New RelicのさまざまなAPIおよびマイクロサービスからデータを返すための単一のAPIインタフェースがあります。NerdGraphには、時間経過とともに他の設定機能が追加される予定です。

NerdGraphは、フェッチするデータの過不足なしに必要なデータを正確に要求できるオープンソースAPI形式であるGraphQLを使用して構築されています。

NerdGraphの使い方については、この7分間のビデオをご覧ください。

さらにビデオチュートリアルをご覧になりたい方は、New Relic UniversityのNerdGraphの紹介にアクセスしてください。またはNew Relic APIのオンラインコースをご覧ください。

要件とエンドポイント

NerdGraphの要件に関する注記：

• NerdGraphには、GraphiQLエクスプローラーで生成してアクセスできるNew Relicのユーザーキーが必要です。
• ユーザータイプと割り当てられたロールは、NerdGraphの権限に影響を与える可能性があります。詳細については、アクセスに影響する要因を参照してください。

NerdGraphエンドポイントは次のとおりです。

• 主要なエンドポイント： https://api.newrelic.com/graphql
• EUデータセンターを使用するアカウントのエンドポイント： https://api.eu.newrelic.com/graphql

エンドポイントにアクセスするには、次のcURLコマンドを使用します：

curl -X POST https://api.newrelic.com/graphql \
-H 'Content-Type: application/json' \
-H 'API-Key: YOUR_NEW_RELIC_USER_KEY' \
-d '{ "query":  "{ requestContext { userId apiKey } }" } '

GraphiQLエクスプローラーを使用する

GraphQLの使用を開始するには、GraphQLを使用するためのオープンソースグラフィカルインタフェースであるGraphiQLエクスプローラーを使用することをお勧めします。これを使用すると、データスキーマを検索し、組み込みのオブジェクト定義を読み込み、クエリを構築して実行できます。

GraphQLを使用するには、ユーザーキーと呼ばれるユーザー固有のNew Relic APIキーが必要です。APIキーは、GraphiQLエクスプローラーで生成でき、APIキードロップダウンを使用して既存のキーを探すこともできます。

GraphiQLエクスプローラーの場所：

• New RelicアカウントがEUデータセンターを使用している場合は、api.eu.newrelic.com/graphiqlにアクセスします。
• それ以外の場合は、api.newrelic.com/graphiqlを使用します。

クエリの作成方法については、GraphiQLエクスプローラーの使用に関するヒントを参照してください。

NerdGraphの機能

NerdGraph機能は、主に以下の2つのカテゴリに分類できます。

• データにクエリを実行します。データは、プログラム的なワークフローで使用する、カスタマイズされたデータ可視化のためのNew Relicアプリを構築するなどのさまざまな目的のためにフェッチできます。
• 機能を設定します。現在、さまざまな設定を利用できますが、時間経過とともにさらに機能が追加されます。タグの追加、ワークロードの設定、「ゴールデンメトリクス」のカスタマイズなどを実行できます。

NerdGraphを使用すると、さまざまなデータを返す設定が行えます。NerdGraphで何ができるかを確認する1つの方法は、NerdGraphエクスプローラーを使用してクエリの構築とスキーマの検索を開始することです。

以下は、最も一般的に使用されるNerdGraphの機能の一部です。

• 監視対象のエンティティに関するデータの取得
• NRQLを使用するデータのクエリ（NRQL：当社のクエリ言語）
• ダッシュボードを作成する

利用可能なNerdGraphドキュメントは以下になります。

NerdGraphの用語

以下にGraphQLから派生する用語を示します（API形式NerdGraphが使用する用語）。

GraphiQLエクスプローラーを使用する際のヒント

クエリは、NerdGraph GraphiQLエクスプローラーを使用して実行できます。エクスプローラーには、オートコンプリート、クエリ検証などのスキーマ定義や機能が組み込まれています。

query {
   actor {
      account(id: YOUR_ACCOUNT_ID) {
         name
      }
   }
}

{
  "data": {
      "actor": {
         "account": {
            "name": "Data Nerd"
         }
      }
   }
}

query {
   actor {
      account(id: YOUR_ACCOUNT_ID) {
         name
         nrql(query: "SELECT * FROM Transaction") {
            results
         }
      }
      user {
         name
         id
      }
   }
}