Tutoriel NerdGraph : Créer et gérer un dashboard

Vous pouvez utiliser notre API NerdGraph pour créer et gérer .

Présentation

Pour une introduction à notre fonctionnalité personnalisée de dashboard, consultez la documentation du dashboard.

Lorsque vous utilisez NerdGraph pour configurer le dashboard, il est utile de comprendre que nos dashboards sont considérés comme des entités, qui ont leurs propres identifiants d'entité, similaires à d'autres éléments que nous considérons comme des entités, comme les applications de monitoring, les hôtes et les services.

Pour savoir comment ajouter et configurer des widgets et des graphiques dans un dashboard, consultez Configurer des graphiques et d'autres widgets.

Opérations

Nous avons défini une granulaire qui vous permet GraphQL API d'exécuter différentes dashboard opérations en fonction de leur objectif et de leur portée.

dashboard opérations CRUD

Voici les opérations liées à la création, la lecture, la mise à jour et la suppression (CRUD).

Opération	Type d'opération GraphQL	Remarques
`actor > entity()`	requête	Obtenir le fonctionnement dashboard . Vous pouvez obtenir toutes les données dashboard et widget pour une entité dashboard donnée GUID.
`dashboardCreate()`	mutation	Créer une opération dashboard . Vous pouvez créer un dashboard attaché à un compte spécifique en spécifiant tous ses éléments, des métadonnées à widget configuration.
`dashboardUpdate()`	mutation	Mettre à jour le fonctionnement dashboard . Vous pouvez mettre à jour un existant dashboard dashboard à GUID l'aide de l'entité . Pour ce faire, vous devez inclure tous les éléments de ce dashboard, même si vous ne mettez pas à jour chaque élément. Par exemple, pour mettre à jour seulement un des nombreux widgets d'un dashboard, vous devrez inclure tous les autres widgets et métadonnées dashboard dans votre mutation.
`dashboardDelete()`	mutation	Opération de suppression dashboard . Vous pouvez supprimer un existant dashboard en dashboard fonction GUID d'un d'entité . Cette opération exécute une suppression logique qui vous permet de récupérer votre dashboard.
`dashboardUndelete()`	mutation	Opération de restauration dashboard . Vous pouvez récupérer un précédemment dashboard dashboard supprimé GUID en fonction d'un d'entité . La balise personnalisée ne peut pas être récupérée.

Opérations de la page du dashboard

Opération	Type d'opération GraphQL	Remarques
`dashboardUpdatePage()`	mutation	Mettre à jour le fonctionnement de la page dashboard . Vous pouvez mettre à jour une page dashboard d'un dashboard existant en fonction d'une entité de page GUID. Vous devez spécifier dashboard l'élément de bord complet et mis à jour, des métadonnées à widget configuration.
`dashboardUpdateWidgetsInPage()`	mutation	Mettre à jour le fonctionnement du widget. Vous pouvez mettre à jour un ensemble de widgets dashboard dashboard existants d'une page étant donné un d'entité de page GUID. Vous devez spécifier l'ensemble des widgets à mettre à jour et leur configuration complète.
`dashboardAddWidgetsToPage()`	mutation	Ajouter une opération de widget. Vous pouvez ajouter un ensemble de nouveaux widgets à une dashboard page en dashboard fonction GUID d'un d'entité de page . Vous devez spécifier l'ensemble des nouveaux widgets et leur configuration complète.

Autres opérations

Opération	Type d'opération GraphQL	Remarques
`dashboardCreateSnapshotUrl()`	mutation	Créer une opération d'instantané de page dashboard . Vous pouvez créer une URL publique pour une dashboard entité de page GUID donnée. La page dashboard est ensuite accessible sous la forme d’un instantané statique dans l’URL publique résultante. L'URL résultante sera obsolète trois mois après sa création.
`actor > dashboard > liveUrls()`	requête	Répertoriez toutes les opérations d'URL en direct. Vous pouvez obtenir la liste complète des URL en direct auxquelles vous avez accès. Une URL en direct est un mécanisme qui vous permet de partager publiquement des pages dashboard et des widgets avec des données à jour ou en direct.
`dashboardWidgetRevokeLiveUrl()`	mutation	Révoquer l'opération d'URL en direct du widget. Vous pouvez révoquer une URL en direct précédemment créée d'un widget. Par conséquent, l’URL en direct ne sera plus disponible au public.
`dashboardCreateLiveUrl()`	mutation	Créez une URL dashboard en direct accessible au public.
`dashboardUpdateLiveUrl()`	mutation	Mettre à jour la date d’expiration d’une URL dashboard en direct accessible au public.
`dashboardRevokeLiveUrl()`	mutation	Révoquer l'URL dashboard en direct accessible au public.
`dashboardUpdateLiveUrlCreationPolicies()`	mutation	Seul un gestionnaire de domaine d’authentification peut utiliser cette mutation pour activer ou désactiver la politique Live URL Creation pour les comptes. L'utilisateur peut créer des URL en direct pour le dashboard dans les comptes où cette politique est activée.

Dashboards multi-comptes

Avec NerdGraph, vous pouvez créer des requêtes de données à partir de plusieurs comptes New Relic . Vous pouvez également créer un dashboard à l'aide de données provenant de plusieurs comptes en ajoutant des identifiants de compte à l'éventail accountIds.

Voici un exemple de création d'un dashboard multi-comptes :

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
    }
  }
}

Limites

Nous avons limité les valeurs que vous pouvez définir pour certaines propriétés dashboard . Cela nous permet de maintenir le dashboard en bon état tout en améliorant sa convivialité.

Limites du dashboard

Limite	Valeur
Nombre maximal de pages dans un dashboard	25
Longueur maximale d'un nom dashboard	255
Longueur maximale d'une description dashboard	1024

Limites de la page du dashboard

Limite	Valeur
Nombre maximal de widgets dans une page dashboard	150
Longueur maximale d'un nom de page dashboard	255
Longueur maximale d'une description de page dashboard	1024

Limite	Valeur
Longueur maximale d'un titre de widget	255
Nombre maximal d'entités liées à un widget	1
Nombre maximal de requêtes dans un widget	20
Colonne de disposition maximale d'un widget	12
Colonne de disposition minimale d'un widget	1
Ligne de disposition minimale d'un widget	1
Largeur de mise en page maximale d'un widget	12
Largeur minimale de mise en page d'un widget	1
Hauteur de mise en page maximale d'un widget	32
Hauteur minimale de mise en page d'un widget	1

Les erreurs des citoyens de première classe

Toutes les mutations dashboard offrent un moyen de demander des erreurs lors de leur exécution. Cela signifie que vous pouvez effectuer vos mutations dashboard et vérifier la réponse afin de détecter les problèmes potentiels attendus. Chaque erreur a un type et une description pour vous aider à identifier la source du problème.

Gardez à l'esprit qu'il s'agit d'erreurs attendues dont nous sommes conscients à l'avance. Vous devez également vérifier les erreurs inattendues qui seront renvoyées dans le champ d’erreurs GraphQL standard.

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : Créer et gérer un dashboard

Présentation

Opérations

dashboard opérations CRUD

Opérations de la page du dashboard

Autres opérations

Dashboards multi-comptes

Dashboard avec requête inter-comptes

Limites

Limites du dashboard

Limites de la page du dashboard

Limites des widgets

Les erreurs des citoyens de première classe

Des erreurs dans chaque réponse à une mutation

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : Créer et gérer un dashboard

Présentation .css-21sua1{background:none;border:none;width:0;padding:0;}

Opérations

dashboard opérations CRUD

Opérations de la page du dashboard

Autres opérations

Dashboards multi-comptes

Limites

Limites du dashboard

Limites de la page du dashboard

Limites des widgets

Les erreurs des citoyens de première classe

Des erreurs dans chaque réponse à une mutation

Présentation