Tutorial de NerdGraph: Crear y configurar widgets de dashboard

Con la API del dashboard de New Relic, puede usar NerdGraph para crear su dashboard. Este documento explica los diferentes tipos de widgets que puede agregar a su dashboard y cómo crearlos y obtenerlos usando la API.

El esquema GraphQL del widget para resultados de consulta y mutación se ve así:

type Widget {
  id
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
  description
  link
}

Dónde:

id: La identificación del widget.
visualization: El tipo de visualización del widget, como una cadena. Por ejemplo: viz.line, viz.area. Consulte los ejemplos a continuación.
layout: La posición y el tamaño del widget en el dashboard. La cantidad máxima de columnas es 12.
title: El título del widget.
linkedEntities: entidad dashboard relacionada con el widget. Actualmente solo admite dashboard de entidades. Es utilizado por la característica de enlace de facetas.
configuration: La configuración tipada del widget. Es una representación GraphQL convenientemente tipada de los widgets más comunes: área, barras, cartelera, líneas, markdown, pastel y tabla.
rawConfiguration: La configuración sin tipo del widget. Es una forma libre (escalar JSON) de almacenar propiedades de widgets no cubiertas por la configuración tipada, como mapa de calor, histograma, bullet, embudo, etc. En este caso, configuration es nulo y rawConfiguration contiene todos los datos requeridos por el widget.
description: Texto opcional que proporciona contexto adicional sobre el widget, que se muestra como información sobre herramientas cuando los usuarios señalan el widget.
link: URL opcional que hace que el título del widget sea cliqueable, lo que permite navegar a dashboards relacionados, documentación o recursos externos. Debe usar el protocolo http:// o https:// y no puede exceder los 2048 caracteres.

La API del dashboard admite widgets con y sin tipo:

Los widgets escritos son área, barra, cartelera, línea, rebajas, circular y tabla. Se pueden crear directamente utilizando NerdGraph, que brinda asistencia con los campos requeridos.

Como entrada:

Sólo necesitas proporcionar el configuration.
visualization puede ser nulo siempre que pueda inferirse de la configuración proporcionada.
Como resultado, la API proporcionará la configuración que proporcionó más la representación sin formato en JSON en rawConfiguration. Por lo tanto, rawConfiguration es siempre un superconjunto de todas las configuraciones widget .

Los widgets sin tipo son todos los demás widgets, como viñetas, histogramas, inventario, etc.

Para el widget sin tipo, conocemos y validamos la forma del JSON proporcionado. Por ejemplo, un mapa de calor tiene una configuración específica que conocemos de antemano, por lo que podemos validarlo.

Como entrada:

configuration En este caso no se considera.
rawConfiguration debe ser provisto. Vea los ejemplos a continuación.
visualization no puede ser nulo y debe ser una cadena fija como viz.heatmap o viz.bullet.
Como resultado, la API responde exactamente con lo que se proporcionó en la entrada.

Área

El área admite múltiples consultas NRQL .

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Cartelera

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el widget.

thresholds

[Object]

Opcional. matriz de umbral para categorizar los resultados de la consulta en diferentes grupos:

alertSeverity: Puede ser NOT_ALERTING, WARNING y CRITICAL.
value: Valor umbral para el grupo de alerta.

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

Línea

Line admite múltiples consultas NRQL .

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Reducción

Elemento de datos del widget	Descripción
`text` Cadena	Contenido que se agregará en el widget de rebajas.

Elemento de datos del widget

Descripción

text

Cadena

Contenido que se agregará en el widget de rebajas.

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

Tarta

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Mesa

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Área (métrica predefinida)

Elemento de datos del widget	Descripción
`duration` Largo	Duración del período de tiempo solicitado, en milisegundos. Cuando se proporciona `endTime`, la ventana de tiempo se establece en los últimos `x` milisegundos que terminan en el momento especificado. Si `endTime` es nulo, la ventana de tiempo se establece en los últimos `x` milisegundos que terminan ahora.
`endTime` Largo	Opcional. Fin de la ventana de tiempo, en milisegundos.
`entityIds` [Integer]	Matriz de ID de agente de origen de los que recuperar datos.
`metrics` [Object]	Solo para `type` `SCOPE_BREAKDOWN` . Lista de métricas a recuperar.
`type` Cadena	Tipo de gráfico predefinido. Puede ser: `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
  }
}

Bala

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el widget.

limit

Flotante

Objetivo con el que se comparan todos los resultados de la consulta.

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

Alimentación de eventos

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Embudos

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Mapa de calor

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Histograma

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Inventario

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

filters

Objeto

Mapa de los filtros a aplicar a las fuentes de infraestructura.

sources

[String]

Lista de fuentes de infraestructura de las que obtener datos. Para obtener más información, consulte nuestros documentos sobre cómo se ven las entradas de inventario.

{
  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

Elemento de datos del widget

Descripción

accountId

Entero

Cuenta de origen de la que recuperar datos.

query

Cadena

La consulta NRQL que proporciona los datos para el 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"
      }
    ]
  }
}

Línea (métrica)

Elemento de datos del widget	Descripción
`accountId` Entero	Cuenta de origen de la que recuperar datos.
`compareWith` Objeto	Opcional. Ventana de tiempo adicional para consultar. Por ejemplo: `{ offsetDuration: 86400000 presentation: { "#c001", "Yesterday" } }`
`duration` Largo	Duración del período de tiempo solicitado, en milisegundos. Cuando se proporciona `endTime`, la ventana de tiempo se establece en los últimos `x` milisegundos que terminan en el momento especificado. Si `endTime` es nulo, la ventana de tiempo se establece en los últimos `x` milisegundos que terminan ahora.
`endTime` Largo	Fin de la ventana de tiempo, en milisegundos.
`entityIds` [Integer]	Matriz de ID de agente de origen de los que recuperar datos.
`facet` Cadena	Opcional. Faceta los datos por el atributo dado. Puede ser `host`, `agent`, `application` o `mobile_version`.
`limit` Entero	Opcional. Cantidad máxima de series a devolver.
`metrics` [Object]	Lista de métricas a recuperar.
`orderBy` Cadena	Opcional. Se utiliza para ordenar los resultados en orden descendente.

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

Mapa de servicios

Elemento de datos del widget	Descripción
`accountId` Entero	Cuenta de origen de la que recuperar datos.
`additionalEntities` [Object]	Opcional. Una matriz de entidades adicionales a incluir. El objetivo es la entidad aguas abajo, mientras que la fuente es aguas arriba. `Type`, `vendor`, `target` y `source` son opcionales.
`deemphasizedConditions` [Object]	Opcional. Las entidades con estas condiciones tienen una apariencia descolorida en el mapa.
`hiddenEntities` [Object]	Opcional. entidad a ser excluida del mapa.
`primaryEntities` [Object]	La entidad principal que inicia el mapa (más arriba).

{
  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"
      }
    ]
  }
}

Te ofrecemos esta traducción automática para facilitar la lectura.

Tutorial de NerdGraph: Crear y configurar widgets de dashboard

Esquema y tipos widget .css-21sua1{background:none;border:none;width:0;padding:0;}

Tipos de widgets

Widget sin tipo

Definiciones widget escritos

Área

Aporte

Producción

Bar

Aporte

Producción

Cartelera

Aporte

Producción

Línea

Aporte

Producción

Reducción

Aporte

Producción

Tarta

Aporte

Producción

Mesa

Aporte

Producción

Definiciones widget sin tipo

Área (métrica predefinida)

Aporte

Producción

Bala

Aporte

Producción

Alimentación de eventos

Aporte

Producción

Embudos

Aporte

Producción

Mapa de calor

Aporte

Producción

Histograma

Aporte

Producción

Inventario

Aporte

Producción

JSON

Aporte

Producción

Línea (métrica)

Aporte

Producción

Mapa de servicios

Aporte

Producción

Esquema y tipos widget