• ログイン無料アカウント

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

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

問題を作成する

ダッシュボードAPI

Dashboards APIでは、ダッシュボードを作成・管理することができます。

NerdGraphのスタートアップ

NerdGraphやGraphQLに初めて触れる方は、まず Introduction to NerdGraph をお読みください。ダッシュボードAPIにすでに慣れている方は、 Create dashboards with NerdGraph をお読みください。

NerdGraphをご利用の際には、当社のダッシュボードは、監視対象のアプリやホスト、サービスなどの他のエンティティからのデータを報告する エンティティであることをご理解ください。

NerdGraph API エクスプローラーは api.newrelic.com/graphiql でご覧いただけます。

オペレーション

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

ダッシュボードのCRUD操作

操作方法GraphQLの操作タイプメモ
actor> entity()問い合わせダッシュボード操作を取得します。与えられたダッシュボード・エンティティGUIDのすべてのダッシュボードおよびウィジェット・データを取得することができます。
dashboardCreate()突然変異ダッシュボードの作成操作。メタデータからウィジェットの設定まで、すべての要素を指定して、特定のアカウントに付属するダッシュボードを作成できます。
ダッシュボードアップデート()突然変異ダッシュボードの更新操作。ダッシュボード・エンティティ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は一般には利用できなくなります。

制限

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

ダッシュボードの制限

リミット
ダッシュボードの最大ページ数20
ダッシュボード名の最大長255
ダッシュボードの説明文の最大長1024

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

リミット
ダッシュボードページ内のウィジェットの最大数100
ダッシュボードのページ名の最大長255
ダッシュボードページの説明文の最大長1024

ウィジェットの制限

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

一級市民としてのエラー

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

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

Copyright © 2022 New Relic Inc.