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

NerdGraphは、データをクエリし、NewRelic機能を構成するためのメインAPIです。NerdGraphを使用してAPIリクエストを行う一般的な方法の1つは、NerdGraphエクスプローラーを使用することです。

エクスプローラーを探す

NerdGraphエクスプローラーを見つけるには：

• EUの場合：New RelicアカウントがEUデータセンターを使用している場合は、 api.eu.newrelic.com/graphiqlにアクセスしてください。
• EU外：アカウントがEU外にある場合は、 api.newrelic.com/graphiqlを使用してください。

NerdGraphエクスプローラーとは何ですか？

NerdGraph APIは、サードパーティのクエリ言語であるGraphQLを使用して構築されています。NerdGraphエクスプローラーは、GraphQLリクエストを作成および作成するためのオープンソースのグラフィカルインターフェイスであるGraphiQLを使用して構築されています。

NerdGraphエクスプローラーを使用して、データスキーマを探索したり、組み込みのオブジェクト定義を読み取ったり、クエリを作成して実行したりできます。

エクスプローラーの使用方法を示す短いビデオを見るには、NerdGraphの概要を参照してください。

あなたが始める前に

ここでレッスンを行う前に、NerdGraphの概要を確認してください。

エクスプローラーに移動し、 NewRelicのユーザーIDとパスワードを使用してログインします。

有効なNewRelicユーザーキーがあることを確認してください。NerdGraphエクスプローラーから作成するか、 APIキーUIで表示して作成できます。

次に、エクスプローラーの使い方を学ぶのに役立ついくつかの手順を説明します。

ステップ1.名前を取得するためのクエリを作成します

簡単なNerdGraphクエリから始めましょう。NewRelicデータベースで自分の名前を検索します。

1. クエリエディタですべてを消去します。
2. クエリエクスプローラーで次のフィールドをこの順序で選択します： actor 、 user 、 name 。

このGraphQLスニペットがエディターに表示されます。

{
  actor {
    user {
      name
    }
  }
}

ステップ2.再生ボタンをクリックして結果を確認します

このクエリでは、NerdGraphに自分の名前を取得するように指示しています。userフィールド内にネストされているnameフィールドを要求しています。これは、 APIキーを所有するユーザーを指します。APIキーはactor内にネストされています。

[再生]ボタンをクリックして結果を確認します。リクエストとほぼ同じ形状です。クエリビルダーのすべてのフィールドは、GraphQLスキーマと呼ばれるものを構成します。このスキーマは、使用可能なすべてのデータ型とその属性を記述します。各フィールドの詳細については、[ドキュメント]ボタンをクリックするか、エディターのフィールドにカーソルを合わせてください。

ステップ3.クエリにフィールドを追加します

これで、クエリにフィールドを追加してみることができます。最も簡単な方法は、クエリビルダーのフィールドをクリックすることです。エクスプローラーは、属性をクエリのどこに配置するかを知っています。この例では、アカウントのid }フィールドとemailフィールドを追加します。

クエリを実行すると、データをオーバーフェッチまたはアンダーフェッチせずに、必要なデータのみが返されます。idフィールドに引数があることに注意してください。引数を渡すことは、NerdGraphクエリをカスタマイズするための強力な方法です。すべてのフィールドとオブジェクトには引数を含めることができるため、複数のクエリを実行する代わりに、必要なクエリを作成するだけです。

{
  actor {
    user {
      name
      email
    }
    account(id: 12345678)
  }
}

ステップ4.突然変異を試す

GraphQLでは、ミューテーションは、オブジェクトを作成、更新、または削除することでデータを変更できる副作用のあるクエリを実行する方法です（REST APIでは、これらは一般にCRUD操作と呼ばれます）。

最初の突然変異の準備はできていますか？

1. エディターの内容を消去します。
2. クエリビルダーを下にスクロールして、 mutationを展開します。
3. 次のスクリーンショットのフィールドを選択します。

この場合、エンティティにカスタムタグを追加しようとしています。errorsを選択しないと、エディターが文句を言うことに注意してください。ミューテーションには、バックエンドで操作がどのように実行されたかを通知する方法が必要です（リクエストが失敗すると応答がnullになります）。

ステップ5.ターミナルでNerdGraphクエリを試してください

満足のいくNerdGraphクエリを作成し、それを他の場所でテストしたいとします。コード対応のクエリとミューテーションをキャプチャするには：

1. [ツール]メニューを選択します。
2. クエリをcurl呼び出しまたはNewRelicCLIコマンドとしてコピーします。

$
# curl version
$
curl https://api.newrelic.com/graphql \
>
  -H 'Content-Type: application/json' \
>
  -H 'API-Key: API_KEY_REDACTED' \
>
  --data-binary '{"query":"{\n  actor {\n    user {\n      name\n      email\n    }\n    account(id: 12345678)\n  }\n}\n", "variables":""}'
$

$
# New Relic CLI version
$
newrelic nerdgraph query '{
$
  actor {
$
    user {
$
      name
$
      email
$
    }
$
    account(id: 12345678)
$
  }
$
}
$
'

次のステップ

これで、NerdGraphクエリの作成とテストの基本を理解しましたが、どのようにしてそれらをクライアントまたはサーバーコードに変換しますか？GraphQLコードジェネレーターなどのソリューションは、NerdGraphクエリを実装用のコードに変換するのに役立ちます。

クエリビルダーでフィールドをクリックしてオブジェクトを展開することにより、より複雑なクエリを作成してみてください（ただし、変更によってアカウントが変更される可能性があるため、変更には注意してください）。以下のセクションでサンプルリクエストのいくつかをチェックしてください。

NerdGraphの詳細と、開発者コミュニティの他のプロジェクトの探索については、 Explorerのハブの投稿を確認してください。

その他のリクエスト例

役立つ可能性のあるNerdGraphリクエストの他の例を次に示します。

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
      }
   }
}