• ログイン今すぐ開始

本書は、お客様のご参考のために原文の英語版を機械翻訳したものです。

英語版と齟齬がある場合、英語版の定めが優先するものとします。より詳しい情報については、本リンクをご参照ください。

問題を作成する

Nerdgraph: ダッシュボードの作成と管理

NerdGraph APIを使用して、ダッシュボードを作成および管理できます。

概要

カスタム ダッシュボード機能の概要については、ダッシュボード ドキュメントを参照してください。

NerdGraph を使用してダッシュボードを構成する場合、監視対象のアプリ、ホスト、サービスなど、エンティティと見なされる他のものと同様に、ダッシュボードがエンティティと見なされ、独自のエンティティ ID があることを理解しておくと役立ちます。

ダッシュボードにウィジェットとグラフを追加して構成する方法については、「グラフとその他のウィジェットを構成する」を参照してください。

オペレーション

目的や範囲に応じて異なるダッシュボード操作を実行できるよう、粒度の高いGraphQL APIを定義しました。

ダッシュボードのCRUD操作

ここでは、作成、読み取り、更新、および削除 (CRUD) に関する操作を示します。

手術GraphQLの操作タイプメモ
actor > entity()クエリダッシュボード操作を取得します。与えられたダッシュボード・エンティティGUIDのすべてのダッシュボードおよびウィジェット・データを取得することができます。
dashboardCreate()突然変異ダッシュボードの作成操作。メタデータからウィジェットの設定まで、すべての要素を指定して、特定のアカウントに付属するダッシュボードを作成できます。
dashboardUpdate()突然変異ダッシュボードの更新操作。ダッシュボード・エンティティGUIDを指定して、既存のダッシュボードを更新することができます。メタデータからウィジェット構成まで、完全に更新されたダッシュボードの要素を指定する必要があります。
dashboardDelete()突然変異ダッシュボードの削除操作。ダッシュボード・エンティティGUIDを指定して、既存のダッシュボードを削除できます。この操作は、ダッシュボードを回復できる論理的な削除を実行します。
dashboardUndelete()突然変異ダッシュボード操作の削除を取り消します。ダッシュボード エンティティ GUID を指定すると、以前に削除されたダッシュボードを復元できます。カスタム タグは復元できません。

ダッシュボードページの操作

操作方法GraphQLの操作タイプメモ
dashboardUpdatePage()突然変異ダッシュボード・ページの更新操作。ダッシュボード・ページ・エンティティGUIDを指定して、既存のダッシュボードの1ページを更新することができます。メタデータからウィジェット構成まで、完全に更新されたダッシュボード・ページ要素を指定する必要があります。
dashboardUpdateWidgetsInPage()突然変異ウィジェットの更新操作。ダッシュボード・ページのエンティティGUIDを指定して、ダッシュボード・ページの既存のウィジェットのセットを更新することができます。更新されるウィジェットのセットとその完全な構成を指定する必要があります。
dashboardAddWidgetsToPage()突然変異ウィジェットの追加操作。ダッシュボード・ページのエンティティGUIDを指定して、新しいウィジェットのセットをダッシュボード・ページに追加できます。新しいウィジェットのセットとその完全な構成を指定する必要があります。

その他の事業

操作方法GraphQLの操作タイプメモ
dashboardCreateSnapshotUrl()突然変異ダッシュボード・ページのスナップショットを作成する操作です。指定されたダッシュボード・ページのエンティティGUIDに対するパブリックURLを作成できます。ダッシュボード・ページは、作成されたパブリックURLの静的スナップショットの形でアクセスできます。
actor > dashboard > liveUrls()クエリすべてのライブURLをリストアップする操作です。自分がアクセスできるライブURLの全リストを取得できます。ライブURLとは、最新のデータやライブデータを含むダッシュボードのページやウィジェットを公開して共有するための仕組みです。
dashboardWidgetRevokeLiveUrl()突然変異ウィジェットのライブURLの操作を取り消します。以前に作成したウィジェットのライブURLを取り消すことができます。その結果、ライブURLは一般には利用できなくなります。

クロスアカウント ダッシュボード

NerdGraph を使用すると、複数の New Relic アカウントからデータのクエリを作成できます。アカウント ID をaccountIds配列に追加することで、複数のアカウントのデータを使用してダッシュボードを作成することもできます。

クロスアカウント ダッシュボードの作成例を次に示します。

制限

ダッシュボードのプロパティの一部に設定できる値を制限しました。これにより、ダッシュボードの使い勝手を高めつつ、良好な状態を保つことができます。

ダッシュボードの制限

制限価値
ダッシュボードの最大ページ数25
ダッシュボード名の最大長255
ダッシュボードの説明文の最大長1024

ダッシュボードのページ制限

制限価値
ダッシュボードページ内のウィジェットの最大数150
ダッシュボードのページ名の最大長255
ダッシュボードページの説明文の最大長1024

ウィジェットの制限

制限価値
ウィジェットタイトルの最大長255
1つのウィジェットにリンクされたエンティティの最大数1
1つのウィジェット内の最大クエリ数20
ウィジェットの最大レイアウト欄12
ウィジェットの最小レイアウト欄1
ウィジェットの最小レイアウト列1
ウィジェットの最大レイアウト幅12
ウィジェットの最小レイアウト幅1
ウィジェットの最大レイアウト高さ32
ウィジェットの最小レイアウト高さ1

一級市民としてのエラー

すべてのダッシュボード・ミューテーションは、実行時にエラーを求める方法を提供しています。つまり、ダッシュボードの変異を実行し、その応答をチェックすることで、予想される潜在的な問題を検出することができます。すべてのエラーにはタイプと説明があり、問題の原因が何かを特定するのに役立ちます。

これらは、事前に把握している想定内のエラーであることを念頭に置いてください。また、標準の GraphQL errors field で返ってくる予期せぬエラーについても確認しておく必要があります。

Copyright © 2023 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.