Tutoriel NerdGraph : créer et configurer un widget dashboard

Avec l'API de dashboard de New Relic vous pouvez utiliser NerdGraph pour créer votre dashboard . Ce document explique les différents types de widgets que vous pouvez ajouter à votre dashboard, et comment les créer et les obtenir à l'aide de l'API.

Le schéma GraphQL du widget pour les sorties de requête et de mutation ressemble à ceci :

type Widget {
  id 
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
}

Où:

id: L'identifiant du widget.
visualization: Le type de visualisation du widget, sous forme de chaîne. Par exemple : viz.line, viz.area. Voir les exemples ci-dessous.
layout: La position et la taille du widget dans le dashboard. Le nombre maximum de colonnes est de 12.
title: Le titre du widget.
linkedEntities: entité du dashboard liée au widget. Actuellement, il ne prend en charge que l'entité dashboard . Il est utilisé par la fonctionnalité de liaison de facettes.
configuration: La configuration typée du widget. Il s'agit d'une représentation GraphQL commodément typée des widgets les plus courants : area, bar, billboard, line, markdown, pie et table.
rawConfiguration: La configuration non typée du widget. Il s'agit d'un moyen libre (scalaire JSON) de stocker les propriétés widget non couvertes par la configuration typée telles que carte thermique, histogramme, bullet, entonnoirs, etc. Dans ce cas, configuration est nul et rawConfiguration contient toutes les données requises par le widget.

L'API du dashboard prend en charge les widgets typés et non typés :

Les widgets typés sont area, bar, billboard, line, markdown, pie et table. Ils peuvent être construits directement à l'aide de NerdGraph, qui fournit une assistance avec les champs obligatoires.

En entrée :

Il vous suffit de fournir le configuration.
visualization peut être nul tant qu'il peut être déduit de la configuration fournie.
En sortie, l'API fournira la configuration que vous avez fournie ainsi que la représentation brute au format JSON à rawConfiguration. Par conséquent, rawConfiguration est toujours un sur-ensemble de toutes les configurations widget .

Les widgets non typés sont tous les autres widgets, tels que puce, histogramme, inventaire, etc.

Pour les widgets non typés, nous connaissons et validons la forme du JSON fourni. Par exemple, une carte thermique a une configuration spécifique que nous connaissons à l’avance, nous pouvons donc la valider.

En entrée :

configuration n'est pas pris en compte dans ce cas.
rawConfiguration doit être fourni. Voir les exemples ci-dessous.
visualization ne peut pas être nul et doit être une chaîne fixe comme viz.heatmap ou viz.bullet.
En sortie, l'API répond exactement avec ce qui a été fourni en entrée.

Zone

Area prend en charge plusieurs requêtes NRQL .

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    configuration: {
      area: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
        }
      }
    }
    rawConfiguration: null
  }
}

{
  "visualization": "viz.area",
  "configuration": {
    "area": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
        }
      ]
    },
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
      }
    ]
  }
}

Bar

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{  
  widgets: {
    configuration: {
      bar: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
        }
      }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.bar",
  "configuration": {
    "area": null,
    "bar": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName"
        }
      ]
    },
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ]
  }
}

Panneau d'affichage

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

thresholds

[Object]

Facultatif. éventail de seuil permettant de catégoriser les résultats de la requête en différents groupes :

alertSeverity: Cela peut être NOT_ALERTING, WARNING et CRITICAL.
value:Valeur seuil pour le groupe d'alerte.

{  
  widgets: {
    configuration: {
      billboard: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
        }
        thresholds: {
          alertSeverity: CRITICAL
          value: 3
        }
      }
    }
    rawConfiguration: null
  }
}

{
  "visualization": "viz.billboard",
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName"
        }
      ],
      "thresholds": [
        {
          "alertSeverity": "CRITICAL",
          "value": 3
        }
      ]
    },
    "line": null,
    "markdown": null,
    "pie": null,
    "table": null
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ],
    "thresholds": [
      {
        "alertSeverity": "CRITICAL",
        "value": 3
      }
    ]
  }
}

Doubler

Line prend en charge plusieurs requêtes NRQL .

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    configuration: {
      line: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
        }
      }
    }
    rawConfiguration: null
  }
}

{
  "visualization": "viz.line",
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": null,
    "line": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
        }
      ]
    },
    "markdown": null,
    "pie": null,
    "table": null
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName TIMESERIES"
      }
    ]
  }
}

Réduction

Élément de données du widget	Description
`text` Chaîne	Contenu à ajouter dans le widget markdown.

Élément de données du widget

Description

text

Chaîne

Contenu à ajouter dans le widget markdown.

{
  "visualization": "viz.markdown",
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": {
      "text": "My markdown"
    },
    "pie": null,
    "table": null
  },
  "rawConfiguration": {
    "text": "My markdown"
  }
}

Tarte

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    configuration: {
      pie: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction FACET appName"
        }
      }
    }
    rawConfiguration: null
  }  
}

{
  "visualization": "viz.pie",
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction FACET appName"
        }
      ]
    },
    "table": null
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction FACET appName"
      }
    ]
  }
}

Tableau

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    configuration: {
      table: {
        nrqlQueries: {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction"
        }
      }
    }
    rawConfiguration: null
  }
}

{
  "visualization": "viz.table",
  "configuration": {
    "area": null,
    "bar": null,
    "billboard": null,
    "line": null,
    "markdown": null,
    "pie": null,
    "table": {
      "nrqlQueries": [
        {
          "accountId": 12345678,
          "query": "SELECT count(*) FROM Transaction"
        }
      ]
    }
  },
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction"
      }
    ]
  }
}

Surface (métriques prédéfinies)

Élément de données du widget	Description
`duration` Long	Durée de la fenêtre temporelle demandée, en millisecondes. Lorsque `endTime` est fourni, la fenêtre temporelle est définie sur les `x` dernières millisecondes se terminant à l'heure spécifiée. Si `endTime` est nul, la fenêtre temporelle est définie sur les `x` dernières millisecondes se terminant maintenant.
`endTime` Long	Facultatif. Fin de la fenêtre temporelle, en millisecondes.
`entityIds` [Integer]	éventail d'identifiants agent sources à partir desquels récupérer des données.
`metrics` [Object]	Pour `type` `SCOPE_BREAKDOWN` seulement. Liste des métriques à récupérer.
`type` Chaîne	Type du graphique prédéfini. Cela peut être : `APPLICATION_BREAKDOWN`, `BACKGROUND_BREAKDOWN`, `BROWSER_BREAKDOWN`, `GC_RUNS_BREAKDOWN`, `SCOPE_BREAKDOWN`, `SOLR_BREAKDOWN.`

{
  widgets: {
    visualization: "viz.area"
    configuration: null
    rawConfiguration: {
      type:SCOPE_BREAKDOWN
      endTime: null
      entityIds: [1]
      metrics: [{
        name: "Mobile/Activity/Name/Display"
      }]
      duration: 3600
    }
  }
}

{
  "visualization": "viz.area",
  "configuration": null,
  "rawConfiguration": {
    "type": "SCOPE_BREAKDOWN",
    "endTime": null,
    "entityIds": [1],
    "metrics": [
      {
        "name": "Mobile/Activity/Name/Display"
      }
    ],
    "duration": 3600
  }
}

Balle

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

limit

virgule flottante

Objectif par rapport auquel tous les résultats de la requête sont comparés.

{
  widgets: {
    visualization: "viz.bullet"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [
        {
          accountId: 12345678,
          query: "SELECT count(*) FROM Transaction"
        }
      ]
      limit: 2.4
    }
  }
}

{
  "visualization": "viz.bullet",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT count(*) FROM Transaction"
      }
    ],
    "limit": 2.4
  }
}

flux d'événements

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    visualization: "viz.event-feed"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT * FROM InfrastructureEvent"
        }
      ]    
    }
  }
}

{
  "visualization": "viz.event-feed",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT * FROM InfrastructureEvent"
      }
    ]
  }
}

Entonnoir

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    visualization: "viz.funnel"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT funnel(SESSION,
            WHERE name ='Controller/about/main' AS 'Step 1',
            WHERE name ='Controller/about/careers' AS 'Step 2')
            FROM PageView"
        }
      ]
    }
  }
}

{
  "visualization": "viz.funnel",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT funnel(SESSION, \n WHERE name ='Controller/about/main' AS 'Step 1', \n WHERE name ='Controller/about/careers' AS 'Step 2') \n FROM PageView"
      }
    ]
  }
}

carte thermique

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    visualization: "viz.heatmap"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT histogram(duration) FROM Transaction Facet appName"
        }
      ]
    }
  }
}

{
  "visualization": "viz.heatmap",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT histogram(duration) FROM Transaction Facet appName"
      }
    ]
  }
}

Histogramme

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    visualization: "viz.histogram"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT histogram(duration) FROM Transaction"
        }
      ]
    }
  }
}

{
  "visualization": "viz.histogram",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT histogram(duration) FROM Transaction"
      }
    ]
  }
}

Inventaire

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

filters

Objet

Carte des filtres à appliquer aux sources d'infrastructure.

sources

[String]

Liste des sources d’infrastructure à partir desquelles obtenir des données. Pour plus d'informations, consultez nos documents sur l'apparence des entrées d'inventaire.

{
  widgets: {
    visualization: "infra.inventory"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,  
      filters: {
        providerAccountId: "1"
      }
      sources: [ "aws/elastocache/cluster", "aws/elasticache/node" ]
    }
  }
}

{
  "visualization": "infra.inventory",
  "configuration": null,
  "rawConfiguration": {
    "accountId": 12345678,
    "filters": {
      "providerAccountId": "1"
    },
    "sources": ["aws/elastocache/cluster", "aws/elasticache/node"]
  }
}

JSON

Élément de données du widget

Description

accountId

Entier

Compte source à partir duquel récupérer les données.

query

Chaîne

La requête NRQL qui fournit les données pour le widget.

{
  widgets: {
    visualization: "viz.json"
    configuration: null
    rawConfiguration: {
      nrqlQueries: [      
        {
          accountId: 12345678,
          query: "SELECT * FROM Transaction"
        }
      ]
    }
  }
}

{
  "visualization": "viz.json",
  "configuration": null,
  "rawConfiguration": {
    "nrqlQueries": [
      {
        "accountId": 12345678,
        "query": "SELECT * FROM Transaction"
      }
    ]
  }
}

Ligne (métriques)

Élément de données du widget	Description
`accountId` Entier	Compte source à partir duquel récupérer les données.
`compareWith` Objet	Facultatif. Fenêtre de temps supplémentaire pour la requête. Par exemple: `{ offsetDuration: 86400000 presentation: { "#c001", "Yesterday" } }`
`duration` Long	Durée de la fenêtre temporelle demandée, en millisecondes. Lorsque `endTime` est fourni, la fenêtre temporelle est définie sur les `x` dernières millisecondes se terminant à l'heure spécifiée. Si `endTime` est nul, la fenêtre temporelle est définie sur les `x` dernières millisecondes se terminant maintenant.
`endTime` Long	Fin de la fenêtre temporelle, en millisecondes.
`entityIds` [Integer]	éventail d'identifiants agent sources à partir desquels récupérer des données.
`facet` Chaîne	Facultatif. Facetter les données selon l'attribut donné. Cela peut être `host`, `agent`, `application` ou `mobile_version`.
`limit` Entier	Facultatif. Montant maximum de séries à retourner.
`metrics` [Object]	Liste des métriques à récupérer.
`orderBy` Chaîne	Facultatif. Utilisé pour trier les résultats par ordre décroissant.

{
  widgets: {
    visualization: "viz.line"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,      
      duration: 36000
      endTime: null
      entityIds: [ 100 ]
      facet: null
      limit: null
      metrics: [{
        name: "Errors/all"
        values: [ "error_rate" ]
      }]
      orderBy: null
      compareWith: []
      rawMetricName: "Errors/all"
    }
  }
}

{
  "visualization": "viz.line",
  "configuration": null,
  "rawConfiguration": {
    "accountId": 12345678,
    "duration": 36000,
    "endTime": null,
    "entityIds": [100],
    "facet": null,
    "limit": null,
    "metrics": [
      {
        "name": "Errors/all",
        "values": ["error_rate"]
      }
    ],
    "orderBy": null,
    "compareWith": [],
    "rawMetricName": "Errors/all"
  }
}

Cartographie des services

Élément de données du widget	Description
`accountId` Entier	Compte source à partir duquel récupérer les données.
`additionalEntities` [Object]	Facultatif. Un éventail d'entités supplémentaires à inclure. La cible est l’entité en aval, tandis que la source est en amont. `Type`, `vendor`, `target` et `source` sont facultatifs.
`deemphasizedConditions` [Object]	Facultatif. les entités présentant ces conditions ont une apparence estompée sur la carte.
`hiddenEntities` [Object]	Facultatif. entité à exclure de la carte.
`primaryEntities` [Object]	L'entité primaire qui démarre la carte (la plus en amont).

{
  widgets: {
    visualization: "topology.service-map"
    configuration: null
    rawConfiguration: {
      accountId: 12345678,       
      entitySearchQuery: "alertStatus IN ('RED')"
      additionalEntities: [{
        guid: "AAA"
        type: "APPLICATION"
        vendor: "Company inc."
        sourceGuid: "BBB"
        targetGuid: "CCC"
      }]
      deemphasizedConditions: {
        alertStatus: [ GREEN ]
        entityType: [ APM_APPLICATION_ENTITY ]
      }
      hiddenEntities: [{
        guid: "XXX_2"
        sourceGuid: "YYY_2"
        targetGuid: "ZZZ_2"
      }]
      primaryEntities: [{
        guid: "AAA"
      }]
    }
  }
}

{
  "visualization": "topology.service-map",
  "configuration": null,
  "rawConfiguration": {
    "accountId": 12345678,
    "entitySearchQuery": "alertStatus IN ('RED')",
    "additionalEntities": [
      {
        "guid": "AAA",
        "type": "APPLICATION",
        "vendor": "Company inc.",
        "sourceGuid": "BBB",
        "targetGuid": "CCC"
      }
    ],
    "deemphasizedConditions": {
      "alertStatus": ["GREEN"],
      "entityType": ["APM_APPLICATION_ENTITY"]
    },
    "hiddenEntities": [
      {
        "guid": "XXX_2",
        "sourceGuid": "YYY_2",
        "targetGuid": "ZZZ_2"
      }
    ],
    "primaryEntities": [
      {
        "guid": "AAA"
      }
    ]
  }
}

Cette traduction automatique est fournie pour votre commodité.

Tutoriel NerdGraph : créer et configurer un widget dashboard

schéma et types de widgets .css-21sua1{background:none;border:none;width:0;padding:0;}

Types de widgets

Widget non typé

Définitions widget typés

Zone

Saisir

Sortir

Bar

Saisir

Sortir

Panneau d'affichage

Saisir

Sortir

Doubler

Saisir

Sortir

Réduction

Saisir

Sortir

Tarte

Saisir

Sortir

Tableau

Saisir

Sortir

Définitions widget non typées

Surface (métriques prédéfinies)

Saisir

Sortir

Balle

Saisir

Sortir

flux d'événements

Saisir

Sortir

Entonnoir

Saisir

Sortir

carte thermique

Saisir

Sortir

Histogramme

Saisir

Sortir

Inventaire

Saisir

Sortir

JSON

Saisir

Sortir

Ligne (métriques)

Saisir

Sortir

Cartographie des services

Saisir

Sortir

schéma et types de widgets