• ログイン無料アカウント

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を使用します。

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

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

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

要件とエンドポイント

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エクスプローラーの場所:

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

NerdGraphの機能

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

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

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

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

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

トピック

チュートリアル

アカウントマネジメント

アラート

APMエージェント

APMエージェントの設定

チャートとダッシュボード

クラウドインテグレーション(AWS、Azure、GCP)

クラウドインテグレーションを設定する

データ管理

ディストリビューティッド(分散)トレーシング

エンティティ

ログ管理

New Relic Oneアプリ

New Relic Oneアプリを構築する

パートナーとリセラー

サブスクリプションの管理元の価格設定モデルを使用しているパートナーのみ)

サービスレベル

サービスレベルの設定および管理

合成のモニタリング

モニターの管理

タグ

タグを追加および管理する

ワークロード

ワークロードを表示して設定する

NerdGraphの用語

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

用語

定義

クエリとミューテーション

GraphQLの操作には、以下の2つのクラスがあります。

  • クエリは、データのフェッチにのみ使用する基本的な要求です。クエリは静的ではなく、必要に応じて要求するデータ量を加減できます。各クエリについて、スキーマでサポートされている限り、どのデータを取得するかを厳密に指定できます。
  • ミューテーションは、リソースの作成や設定の変更などのアクションを実行するための要求です。ミューテーションでは、キーワードmutationと、ミューテーションのnameが必要です。

タイプ

Data in GraphQLはタイプにまとめられます。タイプは、スカラー(文字列や数字、booleanなど)またはオブジェクトタイプとなります。

オブジェクトタイプは、一連のフィールドで構成されるカスタムタイプです。たとえば、Userと呼ばれるオブジェクトタイプは、システムのユーザーを表します。

フィールド

フィールドは、クエリを実行できるオブジェクトタイプの情報の断片を表します。フィールドは、スカラー、リスト、またはオブジェクトです。たとえば、Userオブジェクトタイプには、nameという文字列フィールドを指定できます。

インタフェース

インタフェースは、他のオブジェクトタイプがimplementできる一連の一般的なフィールドを表す抽象型です。

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

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

Copyright © 2022 New Relic株式会社。