NerdGraph チュートリアル: ダッシュボードの作成と管理

NerdGraph APIを使用してを作成および管理できます。

概要

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

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

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

オペレーション

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

ダッシュボードのCRUD操作

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

操作方法	GraphQLの操作タイプ	メモ
`actor > entity()`	クエリ	ダッシュボード操作を取得します。与えられたダッシュボード・エンティティGUIDのすべてのダッシュボードおよびウィジェット・データを取得することができます。
`dashboardCreate()`	突然変異	ダッシュボードの作成操作。メタデータからウィジェットの設定まで、すべての要素を指定して、特定のアカウントに付属するダッシュボードを作成できます。
`dashboardUpdate()`	突然変異	ダッシュボード操作を更新します。ダッシュボードエンティティ GUID を使用して既存のダッシュボードを更新できます。これを行うには、すべての要素を更新しない場合でも、そのダッシュボードにすべての要素を含める必要があります。たとえば、ダッシュボード内の複数のウィジェットのうち 1 つだけを更新するには、他のすべてのウィジェットとダッシュボードのメタデータをミューテーションに含める必要があります。
`dashboardDelete()`	突然変異	ダッシュボードの削除操作。ダッシュボード・エンティティGUIDを指定して、既存のダッシュボードを削除できます。この操作は、ダッシュボードを回復できる論理的な削除を実行します。
`dashboardUndelete()`	突然変異	ダッシュボード操作の削除を取り消します。ダッシュボードエンティティ GUID を指定すると、以前に削除されたダッシュボードを復元できます。カスタムタグは復元できません。

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

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

その他の事業

操作方法	GraphQLの操作タイプ	メモ
`dashboardCreateSnapshotUrl()`	突然変異	ダッシュボードページのスナップショット操作を作成します。特定のダッシュボードページエンティティ GUID のパブリック URL を作成できます。生成されたパブリック URL 内の静的スナップショットの形式でダッシュボードページにアクセスできるようになります。作成された URL は作成後 3 か月で廃止されます。
`actor > dashboard > liveUrls()`	クエリ	すべてのライブURLをリストアップする操作です。自分がアクセスできるライブURLの全リストを取得できます。ライブURLとは、最新のデータやライブデータを含むダッシュボードのページやウィジェットを公開して共有するための仕組みです。
`dashboardWidgetRevokeLiveUrl()`	突然変異	ウィジェットのライブURLの操作を取り消します。以前に作成したウィジェットのライブURLを取り消すことができます。その結果、ライブURLは一般には利用できなくなります。
`dashboardCreateLiveUrl()`	突然変異	公開アクセス可能なライブダッシュボード URL を作成します。
`dashboardUpdateLiveUrl()`	突然変異	公開アクセス可能なライブダッシュボード URL の有効期限を更新します。
`dashboardRevokeLiveUrl()`	突然変異	公開アクセス可能なライブダッシュボード URL を取り消します。
`dashboardUpdateLiveUrlCreationPolicies()`	突然変異	認証ドメインマネージャーだけが、このミューテーションを使用してアカウントのLive URL Creationポリシーを有効または無効にすることができます。ユーザーは、このポリシーが有効になっているアカウントのダッシュボードのライブ URL を作成できます。

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

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

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

mutation {
  dashboardCreate(
    accountId: 1
    dashboard: {
      name: "Cross account queries - NerdGraph API - Cross Account Test1"
      description: null
      permissions: PUBLIC_READ_WRITE
      pages: [
        {
          name: "Page 1"
          description: null
          widgets: [
            {
              visualization: { id: "viz.billboard" }
              layout: { column: 1, row: 1, height: 3, width: 4 }
              title: "Cross Account Total Transaction Count"
              rawConfiguration: {
                legend: { enabled: true }
                nrqlQueries: [
                  {
                    accountIds: [1, 1606862, 2212585]
                    query: "SELECT count(*) FROM Transaction"
                  }
                ]
                yAxisLeft: { zero: true }
              }
              linkedEntityGuids: null
            }
            {
              visualization: { id: "viz.pie" }
              layout: { column: 5, row: 1, height: 3, width: 4 }
              title: "Cross Account Pie"
              rawConfiguration: {
                legend: { enabled: true }
                nrqlQueries: [
                  {
                    accountIds: [1, 1606862, 2212585]
                    query: "SELECT count(*) FROM Transaction FACET accountId()"
                  }
                ]
                yAxisLeft: { zero: true }
              }
              linkedEntityGuids: null
            }
            {
              visualization: { id: "viz.line" }
              layout: { column: 9, row: 1, height: 3, width: 4 }
              title: "Cross Account Line"
              rawConfiguration: {
                legend: { enabled: true }
                nrqlQueries: [
                  {
                    accountIds: [1, 1606862, 2212585]
                    query: "SELECT count(*) FROM Transaction FACET accountId() TIMESERIES"
                  }
                ]
                yAxisLeft: { zero: true }
              }
              linkedEntityGuids: null
            }
          ]
        }
      ]
    }
  ) {
    errors {
      description
      type
    }
  }
}

制限

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

ダッシュボードの制限

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

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

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

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

一級市民としてのエラー

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

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

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: ダッシュボードの作成と管理

概要

オペレーション

ダッシュボードのCRUD操作

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

その他の事業

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

クロスアカウントクエリを含むダッシュボード

制限

ダッシュボードの制限

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

ウィジェットの制限

一級市民としてのエラー

すべての変異反応の一部としてのエラー

この機械翻訳は、参考として提供されています。

NerdGraph チュートリアル: ダッシュボードの作成と管理

概要

オペレーション

ダッシュボードのCRUD操作

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

その他の事業

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

クロスアカウント クエリを含むダッシュボード

制限

ダッシュボードの制限

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

ウィジェットの制限

一級市民としてのエラー

すべての変異反応の一部としてのエラー

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

クロスアカウントクエリを含むダッシュボード