New Relic にはいくつかの異なる API があり、それぞれ異なる API キーを使用しています。この資料では、キーの説明、使用目的、アクセス方法について説明しています。
始める準備はできましたか? New Relic のアカウントをお持ちであることをご確認ください 。無料でご利用いただけます。
APIキーUI
ほとんどのキーは、「API keys UI」ページで表示・管理することができます。 アカウントのドロップダウンから 、 APIキー をクリックしてください(取得 APIキーページへの直接リンク )。
NerdGraph をお使いの方は、 GraphiQL explorer からライセンスキーやユーザーキーを管理することができます。
キーの概要
特定のAPIを使用している場合は、そのAPIのドキュメントを参照して、どのキーが必要で、どのキーが推奨されるかを理解してください。当社のAPIについては、 Introduction to APIs をご覧ください。
私たちのキーは、2つのカテゴリーに分けられます。
データインジェストのキー
New Relic にデータを取り込むには、 多くの方法があります。ここでは、データインジェストに使用するAPIキーを紹介します。
- ライセンスキー: APMインジェスト、インフラストラクチャモニタリングインジェスト、および インジェストAPI とそれらを使用する統合に使用される、当社のプライマリインジェストキー。
- ブラウザキー: ブラウザモニタリングのインジェストに使用されます。
- モバイルアプリトークン: モバイルモニタリングのインジェストに使用されます。
- インサートキー: ほとんど非推奨の古いキーで、ライセンスキーと同じ機能を持っています。 ライセンスキーの使用をお勧めします。
インジェストキーの管理に関する推奨事項
データインジェストキーの管理に関するいくつかの推奨事項
- 安全に保管してください。 これらのキーはデータインジェストに使用されるため、インジェストキーをパスワードのように安全に扱うことをお勧めします。これにより、不要なデータが New Relic アカウントに送信されることはありません。データインジェストキーが悪意のある人の手に渡ると、誰かがお客様のアカウントにデータを送信することが可能になり、誤ったアラートが発生したり、データが汚染されたりして、実際の問題の検出が困難になる可能性があります。データインジェストキーが流出し、望ましくないデータが生成されていると思われる場合は、当社の サポートチーム にご相談ください。
- 追加のキーを作成する。 データインジェストキーを必要とする監視ソリューションを設定する場合、可能であれば新しいキーを作成することをお勧めします。アカウントやアプリのオリジナルのデータインジェストキーは、削除や編集ができないため、管理性を高めるために(例えば、キーが露出した場合には削除するなど)、新しいキーを作成してそれを使用することをお勧めします。
問い合わせや設定のためのキー
ここでは、New Relicのデータを照会したり、機能を設定したりする際に使用するキーを紹介します。
- ユーザーキー 、"パーソナルAPIキーとも呼ばれる": NerdGraph (当社のGraphQL API)および REST API のエンドポイントにアクセスする際に使用する。
- REST API キー: REST API に使用されていますが、 ではなく、制限の少ないユーザーキー の使用をお勧めします。
- Insights クエリキー: New Relic のデータを照会する Insights クエリ API で使用します。 この API の代わりに NerdGraph の使用をお勧めします。.
ライセンスキー
データインジェストに使用するプライマリーキーはライセンスキーと呼ばれ、UIや NerdGraph API で ingest - license
としても参照される。
ライセンスキーは、New Relic アカウントに関連付けられた 40 文字の 16 進数の文字列です。 New Relic の組織 の各アカウントには、少なくとも 1 つのライセンスキーがあります。 初めて New Relic にサインアップしたときに、1 つのアカウントを持つ組織が作成され、そのアカウントは独自のライセンスキーを持っています。アカウントが追加されると、それぞれのアカウントには独自のライセンスキーが与えられます。アカウントのオリジナルのライセンスキーは削除できませんが、追加のライセンスキーを作成して管理・削除することができます。
ライセンスキーが使用されるデータインジェストの種類には、以下のものがあります。
- APMのエージェントデータです。
- インフラのエージェントデータ。
- 当社のコアデータインジェストAPI(Metric API, Trace API, Event API, Log API)を介して送信されたデータ、およびこれらのAPIを使用するSDKや統合機能。
ライセンスキーは、ほとんどすべての New Relic データの取り込みに使用されます。主な例外は、ブラウザモニタリングデータ(ブラウザキー を使用)とモバイルモニタリングデータ(モバイルアプリトークン を使用)です。
ライセンスキーの作成と管理
鍵管理のベストプラクティスに関するヒントは、 Ingest key recommendations を参照してください。
ライセンスキーを追加、削除、管理するには、以下の手順で行います。 アカウントのドロップダウンから 、 API キー をクリックしてください( API キーページへの直接リンク を参照)。また、 NerdGraph API を使ってキーを作成・管理することもできます。
なお、アカウントのオリジナルライセンスキー(アカウント作成時に生成されたもの)を削除・変更することはできません。その場合は、 New Relic のサポート にお問い合わせください。
ユーザーキー
New Relic のユーザーキーは、"パーソナル API キー" と呼ばれることもあり、 NerdGraph と REST API を使用する際に必要となります。
ユーザーキーは、特定の New Relic ユーザーと特定のアカウントの両方に関連付けられており、譲渡することはできません。このキーを使用する API では、キーが作成された特定のアカウントだけでなく、そのユーザーがアクセスを許可されたすべてのアカウントに対して問い合わせを行うことができます。キーのユーザーが削除された場合、そのユーザーキーはすべて無効化され、APIリクエストでは有効ではなくなります。
ユーザーキーやその他のAPIキーをUIで表示・管理するには、以下の方法があります。 アカウントのドロップダウンから 、 APIキー (APIキーのページへの直接のリンクはこちら)。
APIでこのキーを管理するには、 Manage keys with NerdGraph を参照してください。また、 NerdGraph GraphiQL explorer からユーザーキーを取得・生成することもできます。
ブラウザキー
データの取り込みに使用する New Relic API キーのひとつに、ブラウザキーがあります。ブラウザキーは、New Relic ブラウザモニタリング からのデータの取り込みを可能にします。
鍵管理のベストプラクティスに関するヒントは、 Ingest key recommendations を参照してください。
このキーを表示および管理するには アカウントのドロップダウンから 、 APIキー (APIキーのページへの直接のリンクはこちら) をクリックします。
アカウント作成時に作成されたオリジナルのブラウザキーを管理・削除することはできません。そのため、 New Relic のサポート にお問い合わせください。
インサートキー
重要
このキーはまだ使用されていますが、 ライセンスキー の使用を強くお勧めします。
データインジェストに使用されるNew Relic APIキーの一つにInsightsインサートキーがあり、"インサートキー")とも呼ばれています。なお、 ライセンスキー は、同じ機能などに使用されているため、このキーよりもライセンスキーをお勧めします。
このキーは、当社の Event API 、 Log API 、 Metric API 、 Trace API 、またはこれらのAPIを使用するツールを介したデータの取り込みに使用されます。
空き状況やアクセスに関するヒント
- これらのキーは、特定のユーザーではなくアカウントに関連付けられているため、キーにアクセスできるアカウントの誰もが使用することができます。
- セキュリティのためのベストプラクティスとして、アプリケーションやデータソースごとに異なるInsightsの挿入キーを使用することをお勧めします。
Insights のインサートキーを見つけて管理するには。 アカウントのドロップダウンから 、 APIキー をクリックします( APIキーページへの直接リンクを取得 )。次に Insights insert keys をクリックします。
REST APIキー
重要
代わりに ユーザーキー を使うことを強くお勧めします。このキーは制限が少ないからです。
REST API キーは、 アラート 、 APM 、 ブラウザ 、 インフラストラクチャ アラート 、および モバイル モニタリング REST API と API Explorer のための REST API を使用するためのものです。
考慮すべきこと
- 可能であれば、REST APIよりも新しい NerdGraph API を使用することをお勧めします。
- 管理者レベルのユーザー権限が必要です。REST API キーや REST API エクスプローラーにアクセスできない場合は、パーミッションが不足していることが原因かもしれません。New Relic のアカウントマネージャーに相談するか、代わりに ユーザーキー を使用してください。
- 各 New Relic アカウントは、 ****REST API キーを 1 つだけ持つことができます。
REST API キーを見つけて管理するには。 account dropdown から、 API keys をクリックします (get a direct link to the API keys page)。次に、 REST API キー をクリックします。API キーを設定または削除する前に、正しいアカウントに対して設定を行っていることを確認してください。
インサイトのクエリキー
Insights クエリキーは、 Insights クエリ API: 現在、New Relic データのクエリには NerdGraph を使用することを推奨しています。
Insights のクエリキーを見つけて管理するには。 アカウントのドロップダウンから 、 API キー をクリックします( API キーページへの直接リンクを取得 )。次に、 Insights クエリキー をクリックします。
管理キー
重要
2020年12月4日より、既存の管理者キーはすべてユーザーキーに移行しました。
既存の管理者キーを有効にするために何かをする必要はありません。APIキーのUIから自動的にアクセスできるようになり、ユーザーキーとして表示され、同じ権限が付与されます。同じワークフローで、他のユーザーキーと同様に管理できます。
移行されたすべての管理者キーには、キーテーブルに「管理者ユーザーキーからの移行」というメモが表示されるので、簡単に見つけることができるでしょう。
アカウントID
アカウントIDをお探しですか? アカウントID をご覧ください。