NerdGraphは、New Relicデータにクエリを実行して、いくつかのNew Relic機能を設定できる当社のGraphQL形式のAPIです。New Relicアカウントにサインアップし、当社のモニタリングサービスをインストールすると、NerdGraphを使い始めることができます。
NerdGraphとは
NerdGraphは、いくつかのNew Relic APIの1つです。NerdGraphは、New Relicデータにクエリを実行して、特定の設定を実行するための推奨APIです(機能の詳細を確認する)。NerdGraphには、New RelicのさまざまなAPIおよびマイクロサービスからデータを返すための単一のAPIインタフェースがあります。NerdGraphには、時間経過とともに他の設定機能が追加される予定です。
重要
NerdGraphは、データ取り込みには使用しません。そのため、当社のデータ取り込みAPIを使用します。
NerdGraphは、フェッチするデータの過不足なしに必要なデータを正確に要求できるオープンソースAPI形式であるGraphQLを使用して構築されています。
要件
始める前に:
- New Relicアカウントが必要です。そのアカウントでは、クエリやミューテーションに含める必要があるAPI にアクセスできます。
- ユーザータイプと割り当てられたロールは、NerdGraphの権限に影響を与える可能性があります。詳細については、アクセスに影響する要因を参照してください。
エンドポイント
使用するAPIエンドポイントは、データセンターの地域によって異なります。
- 主要なエンドポイント:
https://api.newrelic.com/graphql
- EUデータセンターを使用するアカウントのエンドポイント:
https://api.eu.newrelic.com/graphql
エンドポイントにアクセスするには、コードからの呼び出し、NerdGraph APIエクスプローラーの使用、または次のような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 } }" }'
NerdGraph APIエクスプローラーの使用
NerdGraph APIを試す簡単な方法は、NerdGraph APIエクスプローラーを使用することです。このツールの使い方については、NerdGraph APIエクスプローラーのチュートリアルを参照してください。
NerdGraphの機能
NerdGraph機能は、主に以下の2つのカテゴリに分類できます。
- Querying data. データは、プログラム的なワークフローで使用する、カスタマイズされたデータ可視化のためのNew Relicアプリを構築するなどのさまざまな目的のためにフェッチできます。
- Configuring features. 現在、さまざまな設定を利用できますが、時間経過とともにさらに機能が追加されます。タグの追加、ワークロードの設定、「ゴールデンメトリクス」のカスタマイズなどを実行できます。
NerdGraphを使用すると、さまざまなデータを返す設定が行えます。NerdGraphで何ができるかを確認する1つの方法は、NerdGraphエクスプローラーを使用してクエリの構築とスキーマの検索を開始することです。
以下は、最も一般的に使用されるNerdGraphの機能の一部です。
- 監視対象のエンティティに関するデータの取得
- NRQLを使用するデータのクエリ(NRQL:当社のクエリ言語)
- ダッシュボードを作成する
利用可能なNerdGraphドキュメントは以下になります。
トピック | チュートリアル |
---|---|
アカウントマネジメント |
|
アラート |
|
エージェント | |
変更追跡 | |
ダッシュボード | |
クラウドインテグレーション(AWS、Azure、GCP) | |
データ管理 | |
ディストリビューティッド(分散)トレーシング | |
エンティティ |
|
ログ管理 | |
モバイルのモニタリング | |
New Relicアプリ | |
パートナーとリセラー | サブスクリプションの管理(元の価格設定モデルを使用しているパートナーのみ) |
クエリとチャート | |
サービスレベル | |
合成のモニタリング | |
タグ | |
ワークロード |
NerdGraphの用語
以下にGraphQLから派生する用語を示します(API形式NerdGraphが使用する用語)。
用語 | 定義 |
---|---|
クエリとミューテーション | GraphQLの操作には、以下の2つのクラスがあります。 |
タイプ | Data in GraphQLはタイプにまとめられます。タイプは、スカラー(文字列や数字、booleanなど)またはオブジェクトタイプとなります。 オブジェクトタイプは、一連のフィールドで構成されるカスタムタイプです。たとえば、 |
フィールド | フィールドは、クエリを実行できるオブジェクトタイプの情報の断片を表します。フィールドは、スカラー、リスト、またはオブジェクトです。たとえば、 |
インタフェース | インタフェースは、他のオブジェクトタイプが |