Tutorial NerdGraph: Criar e configurar widget dashboard

Com a API do painel New Relic você pode usar o NerdGraph para construir seu painel. Este documento explica os diferentes tipos de widget que você pode adicionar ao seu painel e como criá-los e obtê-los usando a API.

O esquema GraphQL do widget para saídas de consulta e mutação é semelhante a este:

type Widget {
  id 
  visualization
  layout
  title
  linkedEntities
  configuration
  rawConfiguration
}

Onde:

id: o ID do widget.
visualization: o tipo de visualização do widget, como uma string. Por exemplo: viz.line, viz.area. Veja os exemplos abaixo.
layout: a posição e o tamanho do widget no dashboard. A quantidade máxima de colunas é 12.
title: o título do widget.
linkedEntities: entidade dashboard relacionada ao widget. Atualmente ele suporta apenas dashboard entidade. Ele é usado pelo recurso de vinculação de facetas.
configuration: A configuração digitada do widget. É uma representação GraphQL convenientemente digitada do widget mais comum: area, bar, billboard, line, markdown, pie e table.
rawConfiguration: a configuração não digitada do widget. É uma forma livre (escalar JSON) de armazenar propriedades de widgets não cobertas pela configuração digitada, como mapa de calor, histograma, bullet, funis, etc. Neste caso, configuration é nulo e rawConfiguration contém todos os dados exigidos pelo widget.

A API do painel oferece suporte a widgets digitados e não digitados:

Widgets digitados são area, bar, outdoor, line, markdown, pie e table. Eles podem ser construídos diretamente usando o NerdGraph, que auxilia nos campos obrigatórios.

Como entrada:

Você só precisa fornecer o configuration.
visualization pode ser nulo desde que possa ser inferido da configuração fornecida.
Como saída, a API fornecerá a configuração fornecida, além da representação bruta em JSON em rawConfiguration. Portanto, rawConfiguration é sempre um superconjunto de todas as configurações de widget.

Widgets não digitados são todos os outros widgets, como bullet, histograma, inventário, etc.

Para widget não digitado, conhecemos e validamos a forma do JSON fornecido. Por exemplo, um mapa de calor possui uma configuração específica que conhecemos antecipadamente, para que possamos validá-la.

Como entrada:

configuration não é considerado neste caso.
rawConfiguration Deve ser providenciado. Veja os exemplos abaixo.
visualization não pode ser nulo e deve ser uma string fixa como viz.heatmap ou viz.bullet.
Como saída, a API responde exatamente com o que foi fornecido na entrada.

Área

A área suporta múltiplas consultas NRQL .

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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"
      }
    ]
  }
}

Painel publicitário

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o widget.

thresholds

[Object]

Opcional. matriz de limite para categorizar os resultados da consulta em diferentes grupos:

alertSeverity: pode ser NOT_ALERTING, WARNING e CRITICAL.
value: Valor limite para o 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
      }
    ]
  }
}

Linha

Line suporta múltiplas consultas NRQL .

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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"
      }
    ]
  }
}

Remarcação

Elemento de dados do widget	Descrição
`text` Corda	Conteúdo a ser adicionado no widget de remarcação.

Elemento de dados do widget

Descrição

text

Corda

Conteúdo a ser adicionado no widget de remarcação.

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

Torta

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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 dados do widget	Descrição
`duration` Longo	Duração da janela de tempo solicitada, em milissegundos. Quando fornecido com `endTime`, a janela de tempo é definida para os últimos `x` milissegundos que terminam no horário especificado. Se `endTime` for nulo, a janela de tempo será definida para os últimos `x` milissegundos que terminam agora.
`endTime` Longo	Opcional. Fim da janela de tempo, em milissegundos.
`entityIds` [Integer]	Matriz de IDs do agente de origem para buscar dados.
`metrics` [Object]	Somente para `type` `SCOPE_BREAKDOWN` . Lista de métricas a serem buscadas.
`type` Corda	Tipo do gráfico predefinido. Pode 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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o widget.

limit

Float

Meta com a qual todos os resultados da consulta são comparados.

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

Feed de eventos

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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"
      }
    ]
  }
}

Diversão

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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"
      }
    ]
  }
}

Inventário

Elemento de dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

filters

Objeto

Mapa dos filtros a serem aplicados às fontes de infraestrutura.

sources

[String]

Lista das fontes de infraestrutura das quais obter dados. Para obter mais informações, consulte nossos documentos sobre a aparência das entradas de inventário.

{
  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 dados do widget

Descrição

accountId

Inteiro

Conta de origem da qual buscar dados.

query

Corda

A consulta NRQL que fornece os dados para o 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"
      }
    ]
  }
}

Linha (métrica)

Elemento de dados do widget	Descrição
`accountId` Inteiro	Conta de origem da qual buscar dados.
`compareWith` Objeto	Opcional. Janela de tempo adicional para consulta. Por exemplo: `{ offsetDuration: 86400000 presentation: { "#c001", "Yesterday" } }`
`duration` Longo	Duração da janela de tempo solicitada, em milissegundos. Quando fornecido com `endTime`, a janela de tempo é definida para os últimos `x` milissegundos que terminam no horário especificado. Se `endTime` for nulo, a janela de tempo será definida para os últimos `x` milissegundos que terminam agora.
`endTime` Longo	Fim da janela de tempo, em milissegundos.
`entityIds` [Integer]	Matriz de IDs do agente de origem para buscar dados.
`facet` Corda	Opcional. Facete os dados pelo atributo fornecido. Pode ser `host`, `agent`, `application` ou `mobile_version`.
`limit` Inteiro	Opcional. Quantidade máxima de séries a serem devolvidas.
`metrics` [Object]	Lista de métricas a serem buscadas.
`orderBy` Corda	Opcional. Usado para classificar os resultados em ordem decrescente.

{
  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 serviço

Elemento de dados do widget	Descrição
`accountId` Inteiro	Conta de origem da qual buscar dados.
`additionalEntities` [Object]	Opcional. Uma série de entidades adicionais a serem incluídas. O destino é a entidade downstream, enquanto a origem é upstream. `Type`, `vendor`, `target` e `source` são opcionais.
`deemphasizedConditions` [Object]	Opcional. entidade com essas condições aparecem desbotadas no mapa.
`hiddenEntities` [Object]	Opcional. entidade a ser excluída do mapa.
`primaryEntities` [Object]	A entidade principal que inicia o mapa (mais a montante).

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

Esta tradução de máquina é fornecida para sua comodidade.

Tutorial NerdGraph: Criar e configurar widget dashboard

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

Tipos de widget

Widget não digitado

Definições de widget digitadas

Área

Entrada

Saída

Bar

Entrada

Saída

Painel publicitário

Entrada

Saída

Linha

Entrada

Saída

Remarcação

Entrada

Saída

Torta

Entrada

Saída

Mesa

Entrada

Saída

Definições de widget não digitadas

Área (métrica predefinida)

Entrada

Saída

Bala

Entrada

Saída

Feed de eventos

Entrada

Saída

Diversão

Entrada

Saída

Mapa de calor

Entrada

Saída

Histograma

Entrada

Saída

Inventário

Entrada

Saída

JSON

Entrada

Saída

Linha (métrica)

Entrada

Saída

Mapa de serviço

Entrada

Saída

Esquema e tipos de widget