当社の監視ソリューションとAPI 、 APIキーを使用して身元を認証および確認します。 これらのキーにより、組織内の承認されたユーザーのみが New Relic にデータを報告し、そのデータにアクセスし、機能を構成できるようになります。 主キーはライセンスキー (データのレポート用) と ユーザーキー (NerdGraph、GraphQL APIの操作用) です。
API キーの使用を開始するには:
まだお持ちでない場合は、無料アカウントにサインアップしてください エージェントと統合 を使用して、New Relic へのデータの取り込みを開始しますAPI キー UI ページ から API キーを作成および管理して、データの監視をすぐに開始できるようにします主な API キー Key
Details
To view and manage
Read more
License key 、データ取り込みに使用
ライセンスキーは、ほぼすべてのデータを報告するために使用されます (独自のキーを使用するbrowserとモバイル データを除く)。 各キーは特定のアカウントに関連付けられており、必要な数だけ作成できます。
APIキーのUI(直リンク )に移動します。
もっと詳しく知る
Browser key 、データ取り込みに使用
ブラウザ キーは、ブラウザ監視 データを報告するために使用されます。 各キーは特定のアカウントに関連付けられており、必要な数だけ作成できます。
APIキーのUI(直リンク )に移動します。
もっと詳しく知る
Mobile app token 、データ取り込みに使用
モバイルアプリトークンは、 モバイルモニタリング のデータを報告するために使用されます。各トークンは、特定のモバイルアプリに関連付けられています。
監視対象アプリのUIに移動する
もっと詳しく知る
User key 、クエリと設定に使用されます
データのクエリと機能の構成に使用される GraphQL API であるNerdGraph を使用するには、ユーザー キーが必要です。各ユーザー キーは、特定のユーザーに関連付けられています。
APIキーのUI(直リンク )に移動します。
もっと詳しく知る
APIキーの表示と管理 ほとんどのAPI キーは、 をクリックすると表示される ユーザー メニュー のAPI キー ページUI API keys から管理できます。
NerdGraph でキーを表示するには、キー ID をコピーします。 NerdGraphを使ってキーを管理する こともできます
API キーの管理に関する推奨事項 APIキーが悪用されると、セキュリティ上のリスクが発生する可能性があります。例えば
ライセンスキー を持つ誰かがあなたのアカウントに任意のデータを送信する可能性があります。チームメンバーのユーザーキーのいずれかを持つ誰かが、お客様の New Relic データを閲覧し、お客様の New Relic アカウントに変更を加えることができます。 APIキーは、パスワードやその他の機密情報と同様に、安全に取り扱う必要があります。いくつかの推奨事項を紹介します。
API キーをローテーションする 最も一般的な 4 つの API キーをそれぞれローテーションする方法は次のとおりです。
ライセンスキーをローテーションする ライセンスキーは、 ほぼすべてのデータをレポートするために使用されます (独自のキーを使用するbrowserとモバイル監視のデータを除く)。 各キーは特定のアカウントに関連付けられており、ユーザーは好きなだけキーを作成できます。 ライセンスキーは更新できないため、削除して新しいキーを作成して置き換える必要があります。
アカウントのライセンスキーは、 APIキーUI one.newrelic.com/api-keys (EU データセンターの場合はone.eu.newrelic.com/api-keys ) で見つけることができます。 すべての製品管理者権限 またはそれらのキーを表示できるカスタム ロールを持っていない限り、使用権限があるキーのみが表示されます。
デフォルトでは、すべてのNew Relicアカウントは、組織全体で共有されるオリジナルのアカウント ライセンスキーを使用して作成されます。 このキーをAPIキーUIから削除することはできませんが、 New Relicサポートに連絡してキーをローテーションすることはできます。
ユーザー作成のライセンス キーをローテーションするには:
キーをローテーションする New Relic ユーザーとしてログインします。
one.newrelic.com/api-keys (または EU データセンターの場合はone.eu.newrelic.com/api-keys ) に移動します。
API keys ページの右上隅にあるCreate a key クリックします。
新しいキー名を入力し、 Key type にIngest - License 選択し、オプションの説明を追加して、 Save をクリックします。
古いキーを参照するスクリプトまたはコードを新しいキーの値で更新します。 新しいキーを見つけるには、新しいキーと同じ行にある... アイコンをクリックし、次にCopy key をクリックします。
外部依存関係が更新されたら、古いキーと同じ行にある... アイコンをクリックし、次にDelete をクリックすることで、古いキーを安全に削除できます。
キーが正常に削除されると、右下隅に次のメッセージが表示されます。
NerdGraph API を介してライセンス キーを管理することもできます。手順については、 「NerdGraph チュートリアル: API キーの管理」 を参照してください。
ブラウザキーを回転させる ブラウザ キーは、ブラウザ監視データをレポートするために使用されます。各キーは特定のアカウントに関連付けられており、顧客は必要なだけキーを作成できます。
アカウントのbrowserキーは、 APIキーUIのone.newrelic.com/api-keys (EU データセンターの場合はone.eu.newrelic.com/api-keys ) で見つけることができます。 すべての製品管理者権限 またはそれらのキーを表示できるカスタム ロールを持っていない限り、使用権限があるキーのみが表示されます。
デフォルトでは、すべてのNew Relicアカウントは、組織全体で共有されるオリジナルのアカウントbrowserキーを使用して作成されます。 このキーをAPIキーUIから削除することはできませんが、 New Relicサポートに連絡してキーをローテーションすることはできます。
ユーザー作成のブラウザ キーをローテーションするには:
キーをローテーションする New Relic ユーザーとしてログインします。
one.newrelic.com/api-keys (または EU データセンターの場合はone.eu.newrelic.com/api-keys ) に移動します。
API keys ページの右上隅にあるCreate a key クリックします。
新しいキー名を入力し、 Key type にIngest - Browser 選択し、オプションの説明を追加して、 Save をクリックします。
古いキーを参照するスクリプトまたはコードを新しいキーの値で更新します。 新しいキーを見つけるには、新しいキーと同じ行にある... アイコンをクリックし、次にCopy key をクリックします。
外部依存関係が更新されたら、古いキーと同じ行にある... アイコンをクリックし、次にDelete をクリックすることで、古いキーを安全に削除できます。
キーが正常に削除されると、右下隅に次のメッセージが表示されます。
モバイルアプリトークンをローテーションする モバイル監視では、ライセンス キーではなくモバイル アプリ トークンを使用してデータをレポートします。モバイル アプリ トークンはすべて一意であり、アプリケーションが NR1 に登録されるたびに再生成されます。アプリに関連付けられたモバイルキーをローテーションするには、New Relic でアプリを再認証します。
アプリ トークンの詳細については、 「モバイル監視の設定を構成する」 を参照してください。
ユーザーキーをローテーションする New Relic ユーザー キー (「個人 API キー」とも呼ばれます) は、NerdGraph と REST API を使用するために必要です。キーは組織または特定のユーザーに属することができます。
アカウントのユーザー キーは、 APIキーUI one.newrelic.com/api-keys (EU データセンターの場合はone.eu.newrelic.com/api-keys ) で見つけることができます。 すべての製品管理者権限またはそれらのキーを表示できるカスタム ロールを持っていない限り、使用権限があるキーのみが表示されます。
重要 ユーザー キーが侵害されたと思われる場合は、そのユーザーに関連付けられている、またはそのユーザーによって作成されたall キーをローテーションする必要があります。
ユーザー キーをローテーションするには、新しいキーを作成し、ソフトウェア内の古いキーへの参照を更新してから、古いキーを削除します。UI でキーを回転するには:
キーをローテーションする New Relic ユーザーとしてログインします。
one.newrelic.com/api-keys (または EU データセンターの場合はone.eu.newrelic.com/api-keys ) に移動します。
API keys ページの右上隅にあるCreate a key クリックします。
新しいキー名を入力し、 Key type にUser 選択し、オプションの説明を追加して、 Save をクリックします。
古いキーを参照するスクリプトまたはコードを新しいキーの値で更新します。 新しいキーを見つけるには、新しいキーと同じ行にある... アイコンをクリックし、次にCopy key をクリックします。
外部依存関係が更新されたら、古いキーと同じ行にある... アイコンをクリックし、次にDelete をクリックすることで、古いキーを安全に削除できます。
キーが正常に削除されると、右下隅に次のメッセージが表示されます。
NerdGraph API を介してユーザー キーを管理することもできます。手順については、 「NerdGraph チュートリアル: API キーの管理」 を参照してください。
また、古いまたはあまり一般的ではない API キー タイプもいくつかあります。これらのキーをローテーションするには:
Insights 挿入キーと Insights クエリ キーを回転する これらは古いキーであり、顧客による使用は推奨されていませんが、New Relic では引き続きサポートされています。これらのキーは、メトリクス、イベント、ログ、トレース API を介してデータを取り込むために使用され、組織全体に適用されます。
これらのキーをローテーションするには:
管理者権限を持つアカウントで New Relic にログインします。
one.newrelic.com/api-keys (または EU データセンターの場合はone.eu.newrelic.com/api-keys ) に移動します。
ページの左側にあるLooking for other keys? セクションを見つけて、ローテーションするキーの種類のリンクをクリックします。
新しい挿入またはクエリキーを作成するには、 + アイコンをクリックします。
古いキーを参照するスクリプトまたはコードを新しいキー値で更新します。
外部依存関係が更新されたら、古いキーを安全に削除できます。 キーを削除するには、キーの上にマウスを移動してDelete をクリックします。
REST APIキーをローテーションする これは非推奨ですが、New Relic では引き続きサポートされている古いキーです。 現在、REST APIキーの代わりにユーザー キーを使用することをお勧めします。
このキーをローテーションすることはできませんが、削除することはできます。
管理者権限を持つアカウントで New Relic にログインします。
one.newrelic.com/api-keys (または EU データセンターの場合はone.eu.newrelic.com/api-keys ) に移動します。
ページの左側にあるLooking for other keys? セクションを見つけて、 REST API key をクリックします。
Delete REST API Key をクリックします。
Pixie API キーをローテーションする Pixie API キーは、Pixie プラットフォームに対してカスタム アプリケーションを認証するために使用されます。Pixie API キーは変更できません。Pixie API キーをローテーションするには、新しいキーを作成してから、古いキーを削除する必要があります。Pixie API キーの詳細については、Pixie ドキュメントの「API キーの管理」 を参照してください。
パートナーシップ API キーをローテーションする Partnership API は、New Relic の担当者から使用するよう特に指示されない限り、組織では利用できません。API の詳細については、 「パートナーシップ API リファレンス」 を参照してください。
キーを表示または再生成するには、パートナーシップ所有者の認証情報を使用して New Relic にログインし、 Partnerships > Edit settings に移動します。
APIキーについてもっと読む APIキーを作成または管理するには、one.newrelic.com / launcher / api-keys-ui.api-keys-launcherのUI、またはNerdGraphAPI を使用します 。詳細については、キーを選択してください。
ライセンスキー データの取り込みに使用されるメインキーは、ライセンスキーと呼ばれます。 APIキーUIおよびNerdGraph では、このキーはingest - license
として参照されることがあります。
ほとんどすべてのNewRelicデータを取り込むには、ライセンスキーが必要です。例外は、ブラウザー監視データ(ブラウザーキーを使用)とモバイル監視データ(モバイルアプリトークンを使用)です。
ライセンスキーは、 New Relicアカウントに関連付けられた 40 文字の 16 進文字列です。 初めて にNew Relic サインアップする と、単一のアカウントと独自のライセンスキーを持つ組織が作成されます。さらにアカウントを追加すると、各アカウントは独自のライセンスキーから始まります。 アカウント用に最初に作成されたライセンスキーは削除できませんが、管理および削除できる追加のライセンスキーを作成することはできます。これは、キーのローテーションなどのセキュリティ対策を実装するのに役立ちます。 アカウントの元のアカウントのライセンスキーをローテーションする必要がある場合は、サポートにお問い合わせください 。
ユーザーがライセンス キーを表示または管理できないように制限するには、これらの権限を持たないロールをユーザーに割り当てます。 元のユーザー モデル | 元のユーザー モデル 新しいユーザーモデル 。
ブラウザキー ブラウザの監視では、ライセンスキーではなく、ブラウザキーを使用してデータを報告します。ブラウザキーは、ブラウザ監視エージェント からのデータをアカウントに関連付けるために使用されます。
アカウントの作成時に作成された元のbrowserキーを管理または削除することはできませんが、新しいbrowserキーを作成してそれらのキーを削除することはできます。 アカウントの元のbrowserキーのローテーションに関するサポートが必要な場合は、サポートにお問い合わせください 。
モバイルアプリトークン モバイルモニタリングでは、ライセンスキーではなく、モバイルアプリトークンを使用してデータをレポートします。詳細については、モバイルアプリトークン を参照してください。
ユーザーキー New Relic のユーザーキー ("個人用 API キーと呼ばれることもあります)" は、 NerdGraph と弊社の REST API を使用する際に必要です。
ユーザーキー 特定の New Relic ユーザーに関連付けられており、転送できません。 ユーザー キーを使用すると、キーが関連付けられている特定のアカウントだけでなく、アクセスが許可されているすべてのアカウントに対してクエリを実行できます。 New Relic ユーザーが New Relic で削除されると、そのユーザー キーも非アクティブ化され、機能しなくなります。
ユーザー キーは、ユーザーに複数のアカウントへのアクセスを提供しますが、ユーザー キーは単一の特定のアカウント、つまりキーの作成元のアカウントにリンクされます。これの重要な点は、アカウントが削除されると、そのアカウントに関連付けられたユーザー キーが機能しなくなることです。(また、REST API の場合、呼び出しはそのユーザー キーに関連付けられたアカウントに制限されます。)
ユーザーがユーザー キーを表示または管理できないようにするには、これらの権限を持たないロールをユーザー に割り当てます。 新しいユーザーモデル 。
上記で説明した主要な API キーに加えて、一部の New Relic のお客様がまだ使用している古い API キーが他にもいくつかあります。これらのキーをまだ使用していない場合は、おそらく開始する必要はありません。
その他の API キー インサイトインサートキー(非推奨) 重要 このキーはまだ使用されていますが、同じ目的やそれ以上の目的に使用できるライセンスキー を使用することを強くお勧めします。
データの取り込みに使用される古いNewRelicAPIキーの1つは、Insights挿入キー(挿入キーとも呼ばれます)です。ライセンスキーは同じ機能などに使用されることに注意してください。そのため、このキーよりもライセンスキーをお勧めします。
このキーは、当社の Event API 、 Log API 、 Metric API 、および Trace API 、またはこれらの API を使用する統合を経由してデータを取り込むために使用されます。
空き状況やアクセスに関するヒント
これらのキーは、特定のユーザーではなくアカウントに関連付けられているため、キーにアクセスできるアカウントの誰もが使用することができます。
セキュリティのためのベストプラクティスとして、アプリケーションやデータソースごとに異なるInsightsの挿入キーを使用することをお勧めします。
インサイト挿入キーを検索して管理するには:ユーザー メニュー から、API keys をクリックします ( APIキー ページへの直接リンク を取得します)。 次に、 Insights insert keys をクリックします。
管理キー(非推奨) adminキーは、廃止された古いAPIキーの1つです。 2020年12月4日の時点で、既存のすべての管理者キーがユーザーキーに移行されています。
管理者キーを使用していた場合、そのキーを有効にするために何もする必要はありません。APIキーのUIから自動的にアクセスできるようになり、ユーザーキーとしてラベル付けされ、同じパーミッションが付与されます。ユーザーキーと同じように、同じワークフローで管理することができます。
移行されたすべての管理キーには、キー テーブルにMigrated from an admin user key というメモが付きます。
REST APIキー(非推奨) REST APIキーは、REST API 使用するための古いキーです。 現在、REST APIキーの代わりにユーザー キーを使用することをお勧めします。 ユーザーはアカウント固有ではなくユーザー固有であるため、組織はチーム メンバーのアクセスをより細かく制御できます。 また、REST API の代わりに、新しい API であるNerdGraph を 使用することをお勧めします。
考慮すべきこと
各New Relicアカウントは one 個の REST APIキーのみを持つことができます。
RESTAPIキーの代わりにユーザーキーを使用することをお勧めします。
可能であれば、REST API より NerdGraph を使用することをお勧めします。
管理者レベルのユーザー権限が必要です。 RESTAPIキーまたはRESTAPIエクスプローラーにアクセスできない場合は、権限がないことが原因である可能性があります。 New Relicアカウントマネージャーに相談するか、代わりにユーザーキーを使用してください。
REST APIキーを見つけて管理するには:ユーザー メニュー から API keys をクリックします ( APIキー ページへの直接リンク を取得します)。 次に、 REST API key をクリックします。 APIキーを設定または削除する前に、正しいアカウントに対して実行していることを確認してください。