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を使用します。
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を使用します。
クエリを構築する方法のヒントについては、クエリの構築をご覧ください。
NerdGraphでできること:
NerdGraph機能は、主に以下の2つのカテゴリに分類できます。
- New Relicデータにクエリを実行する。データは、プログラム的なワークフローで使用する、カスタマイズされたデータ可視化のためのNew Relic Oneアプリを構築するなどのさまざまな目的のためにフェッチできます。
- New Relicの機能を設定する。現在、さまざまな設定を利用できますが、時間経過とともにさらに機能が追加されます。タグの追加、ワークロードの設定、「ゴールデンメトリクス」のカスタマイズなどを実行できます。
NerdGraphを使用すると、さまざまなNew Relicデータを返すことができますが、一般的な使用例に関するチュートリアルを作成しました。
トピック | チュートリアル |
---|---|
アラート | |
APMエージェント | |
Applied Intelligence | |
クラウドインテグレーション(AWS、Azure、GCP) | |
ダッシュボード | |
データ管理 | |
ディストリビューティッド(分散)トレーシング | |
エンティティ |
|
キー管理 | キーを作成して管理する(データ取り込みに使用するライセンスキー、およびユーザーキー) |
ログ管理 | |
New Relic Oneアプリ | |
パートナーとリセラー | サブスクリプションの管理(元の価格設定モデルを使用しているパートナーのみ) |
データにクエリを実行する | NRQLを使用するクエリ(NRQL:当社のクエリ言語) |
サービスレベル | |
タグ | |
ワークロード |
NerdGraphの用語
以下にGraphQLから派生する用語を示します(API形式NerdGraphが使用する用語)。
用語 | 定義 |
---|---|
クエリとミューテーション | GraphQLの操作には、以下の2つのクラスがあります。 |
タイプ | Data in GraphQLはタイプにまとめられます。タイプは、スカラー(文字列や数字、booleanなど)またはオブジェクトタイプとなります。 オブジェクトタイプは、一連のフィールドで構成されるカスタムタイプです。たとえば、 |
フィールド | フィールドは、クエリを実行できるオブジェクトタイプの情報の断片を表します。フィールドは、スカラー、リスト、またはオブジェクトです。たとえば、 |
インタフェース | インタフェースは、他のオブジェクトタイプが |
GraphiQLエクスプローラーを使用する際のヒント
クエリは、NerdGraph GraphiQLエクスプローラーを使用して実行できます。エクスプローラーには、オートコンプリート、クエリ検証などのスキーマ定義や機能が組み込まれています。