Tutorial de NerdGraph: Crear y gestionar un panel de control

Puede utilizar nuestra API NerdGraph para crear y administrar .

Descripción general

Para obtener una introducción a nuestra característica personalizada del tablero, consulte los documentos del tablero.

Al usar NerdGraph para configurar el dashboard, es útil comprender que nuestro dashboard se considera entidad, que tiene sus propios ID de entidad, similar a otras cosas que consideramos entidad, como aplicaciones de monitoreo, hosts y servicios.

Para saber cómo agregar y configurar widgets y gráficos en un dashboard, consulte Configurar gráficos y otros widgets.

Operaciones CRUD dashboard

Este documento explica cómo emplear nuestra API NerdGraph para crear, leer, actualizar y eliminar los dashboards (CRUD). Estas operaciones modifican todo el dashboard.

Crear un dashboard

Un dashboard requiere al menos una página. Puede crear un dashboard con una o más páginas, y cada página puede tener uno o más widgets.

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard NerdGraph para crear un nuevo dashboard y su configuración.
Cerciorar de incluir todos los campos obligatorios, como name, permissions y al menos una página.

mutation {
  dashboardCreate(
    accountId: 1
    dashboard: {
      name: "My New Dashboard"
      description: "This is my new dashboard created via NerdGraph"
      permissions: PUBLIC_READ_WRITE
      pages: [
        {
          name: "Page 1"
          description: "This is the first page"
          widgets: [
            {
              visualization: { id: "viz.billboard" }
              layout: { column: 1, row: 1, height: 3, width: 4 }
              title: "Total Transaction Count"
              rawConfiguration: {
                nrqlQueries: [
                  { accountIds: [1], query: "SELECT count(*) FROM Transaction" }
                ]
              }
            }
          ]
        }
      ]
      variables: [
        {
          name: "nrql_variable"
          title: "countries"
          type: NRQL
          nrqlQuery: {
            accountIds: [1]
            query: "SELECT uniqueCount(countryCode) FROM PageView"
          }
          replacementStrategy: STRING
        }
      ]
    }
  ) {
    entityResult {
      guid
      name
      description
      createdAt
      updatedAt
      owner {
        email
        userId
      }
      permissions
      pages {
        guid
        name
        description
        createdAt
        updatedAt
        widgets {
          id
          visualization {
            id
          }
          layout {
            column
            row
            height
            width
          }
          title
          linkedEntities {
            guid
          }
          rawConfiguration
        }
      }
      variables {
        name
        items {
          title
          value
        }
        defaultValues {
          value {
            string
          }
        }
        nrqlQuery {
          accountIds
          query
        }
        options {
          excluded
          ignoreTimeRange
          showApplyAction
        }
        title
        type
        isMultiSelection
        replacementStrategy
      }
    }
    errors {
      type
      description
    }
  }
}

Recomendamos emplear variables para facilitar la actualización de su consulta. Aquí está la misma mutación que la anterior, pero usando variables:

mutation CreateDashboard($accountId: Int!, $dashboard: DashboardInput!) {
  dashboardCreate(accountId: $accountId, dashboard: $dashboard) {
    entityResult {
      guid
      name
      description
      createdAt
      updatedAt
      owner {
        email
        userId
      }
      permissions
      pages {
        guid
        name
        description
        createdAt
        updatedAt
        widgets {
          id
          visualization {
            id
          }
          layout {
            column
            row
            height
            width
          }
          title
          linkedEntities {
            guid
          }
          rawConfiguration
        }
      }
      variables {
        name
        items {
          title
          value
        }
        defaultValues {
          value {
            string
          }
        }
        nrqlQuery {
          accountIds
          query
        }
        options {
          excluded
          ignoreTimeRange
          showApplyAction
        }
        title
        type
        isMultiSelection
        replacementStrategy
      }
    }
    errors {
      type
      description
    }
  }
}

Y aquí están las variables a emplear con esta mutación:

{
  "accountId": 1,
  "dashboard": {
    "name": "My New Dashboard",
    "description": "This is my new dashboard created via NerdGraph",
    "permissions": "PUBLIC_READ_WRITE",
    "pages": [
      {
        "name": "Page 1",
        "description": "This is the first page",
        "widgets": [
          {
            "visualization": { "id": "viz.billboard" },
            "layout": { "column": 1, "row": 1, "height": 3, "width": 4 },
            "title": "Total Transaction Count",
            "rawConfiguration": {
              "nrqlQueries": [
                {
                  "accountIds": [1],
                  "query": "SELECT count(*) FROM Transaction"
                }
              ]
            }
          }
        ]
      }
    ],
    "variables": [
      {
        "name": "nrql_variable",
        "title": "countries",
        "type": "NRQL",
        "nrqlQuery": {
          "accountIds": [1],
          "query": "SELECT uniqueCount(countryCode) FROM PageView"
        },
        "replacementStrategy": "STRING"
      }
    ]
  }
}

Leer un dashboard

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee actor > entity() para encontrar el dashboard por su GUID de entidad.
Emplee API dashboard NerdGraph para leer el dashboard existente y su configuración.

En este ejemplo, reemplace DASHBOARD_GUID con el GUID real del dashboard que desea leer:

query GetDashboardEntityQuery {
  actor {
    entity(guid: "DASHBOARD_GUID") {
      ... on DashboardEntity {
        guid
        name
        description
        createdAt
        updatedAt
        owner {
          email
          userId
        }
        permissions
        pages {
          guid
          name
          description
          createdAt
          updatedAt
          widgets {
            id
            visualization {
              id
            }
            layout {
              column
              row
              height
              width
            }
            title
            linkedEntities {
              guid
            }
            rawConfiguration
          }
        }
        variables {
          name
          items {
            title
            value
          }
          defaultValues {
            value {
              string
            }
          }
          nrqlQuery {
            accountIds
            query
          }
          options {
            excluded
            ignoreTimeRange
            showApplyAction
          }
          title
          type
          isMultiSelection
          replacementStrategy
        }
      }
    }
  }
}

Dependiendo de la información que desee recuperar, puede modificar los campos en la consulta.

Actualizar un dashboard

Para actualizar un dashboard, debe proporcionar la configuración completa del dashboard, incluidas todas sus páginas y widgets, incluso si solo está actualizando un elemento. La operación de actualización es un reemplazo completo del contenido del dashboard.

Importante

Al actualizar un dashboard, si no se proporciona el GUID de la página o el ID widget, las páginas o widgets existentes se eliminarán del dashboard y se reemplazarán por los nuevos especificados en la mutación.

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard de NerdGraph para obtener la configuración dashboard existente leyendo el dashboard por su GUID de entidad, como se muestra en la sección Leer un dashboard.
Modifique los campos que desea actualizar en la configuración dashboard.
Emplee API dashboard de NerdGraph para actualizar el dashboard existente con la configuración modificada.

Importante

Si está empleando Facet Linking en su widget, al leer el dashboard el campo es linkedEntities { guid } pero al actualizar el dashboard debe emplear linkedEntityGuids: [ "GUID" ].

mutation UpdateDashboard(
  $guid: EntityGuid!
  $dashboard: DashboardUpdateInput!
) {
  dashboardUpdate(guid: $guid, dashboard: $dashboard) {
    entityResult {
      guid
      name
      description
      createdAt
      updatedAt
      owner {
        email
        userId
      }
      permissions
      pages {
        guid
        name
        description
        createdAt
        updatedAt
        widgets {
          id
          visualization {
            id
          }
          layout {
            column
            row
            height
            width
          }
          title
          linkedEntities {
            guid
          }
          rawConfiguration
        }
      }
      variables {
        name
        items {
          title
          value
        }
        defaultValues {
          value {
            string
          }
        }
        nrqlQuery {
          accountIds
          query
        }
        options {
          excluded
          ignoreTimeRange
          showApplyAction
        }
        title
        type
        isMultiSelection
        replacementStrategy
      }
    }
    errors {
      type
      description
    }
  }
}

Y aquí están las variables a emplear con esta mutación:

{
  "guid": "DASHBOARD_GUID",
  "dashboard": {
    "name": "My Updated Dashboard",
    "description": "This is my updated dashboard created via NerdGraph",
    "permissions": "PUBLIC_READ_WRITE",
    "pages": [
      {
        "guid": "PAGE_GUID",
        "name": "Updated Page 1",
        "description": "This is the updated first page",
        "widgets": [
          {
            "id": "WIDGET_ID",
            "visualization": { "id": "viz.billboard" },
            "layout": { "column": 1, "row": 1, "height": 3, "width": 4 },
            "title": "Updated Total Transaction Count",
            "linkedEntityGuids": [],
            "rawConfiguration": {
              "nrqlQueries": [
                {
                  "accountIds": [1],
                  "query": "SELECT count(*) FROM Transaction"
                }
              ]
            }
          }
        ]
      }
    ],
    "variables": [
      {
        "name": "nrql_variable",
        "title": "countries",
        "type": "NRQL",
        "nrqlQuery": {
          "accountIds": [1],
          "query": "SELECT uniqueCount(countryCode) FROM PageView"
        },
        "replacementStrategy": "STRING"
      }
    ]
  }
}

Eliminar un dashboard

Para eliminar un dashboard, debe proporcionar el GUID de entidad del dashboard que desea eliminar. Esta operación ejecuta una eliminación lógica que le permite recuperar su dashboard.

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard NerdGraph para eliminar el dashboard por su GUID de entidad.
Confirme la eliminación marcando status y errors.

Recuperar un dashboard

Puede recuperar un dashboard eliminado previamente proporcionado un GUID de entidad dashboard. La etiqueta personalizada no se puede recuperar.

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard NerdGraph para recuperar el dashboard mediante su GUID de entidad.
Confirme la recuperación marcando errors si hay alguno.

Operaciones de la página dashboard

Estas operaciones modifican una página específica de un dashboard.

Actualizar una página dashboard

Puede actualizar una página de un dashboard existente dado un GUID de entidad de página de dashboard. Debe especificar el elemento de página completo y actualizado dashboard, desde los metadatos hasta la configuración widget.

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard de NerdGraph para obtener la configuración dashboard existente leyendo el dashboard por su GUID de entidad, como se muestra en la sección Leer un dashboard.
Identifique y extraiga la página que desea actualizar desde el dashboard.
Modifique los campos que desea actualizar en la página.
Emplee dashboardUpdatePage() para modificar la página.
Marque errors si hay alguno.

Importante

Al actualizar una página, si no se proporcionan los identificadores widget, el widget existente se eliminará del dashboard y se reemplazará por los nuevos especificados en la mutación.

Sugerencia

Puede agregar un nuevo widget a una página incluyéndolo en la matriz widgets sin un campo id.
Puedes eliminar un widget de una página omitiéndolo de la matriz widgets.

mutation UpdateDashboardPage(
  $pageGuid: EntityGuid!
  $page: DashboardUpdatePageInput!
) {
  dashboardUpdatePage(guid: $pageGuid, page: $page) {
    errors {
      type
      description
    }
  }
}

Y aquí están las variables a emplear con esta mutación:

{
  "guid": "PAGE_GUID",
  "page": {
    "name": "Updated Page 1",
    "description": "This is the updated first page",
    "widgets": [
      {
        "id": "WIDGET_ID",
        "visualization": { "id": "viz.billboard" },
        "layout": { "column": 1, "row": 1, "height": 3, "width": 4 },
        "title": "Updated Total Transaction Count",
        "linkedEntityGuids": [],
        "rawConfiguration": {
          "nrqlQueries": [
            {
              "accountIds": [1],
              "query": "SELECT count(*) FROM Transaction"
            }
          ]
        }
      }
    ]
  }
}

mutation UpdateDashboardPage(
  $pageGuid: EntityGuid!
  $page: DashboardUpdatePageInput!
) {
  dashboardUpdatePage(guid: $pageGuid, page: $page) {
    errors {
      type
      description
    }
  }
}

Y aquí están las variables a emplear con esta mutación:

{
  "guid": "PAGE_GUID",
  "page": {
    "name": "Updated Page 1",
    "description": "This is the updated first page",
    "widgets": [
      {
        "id": "WIDGET_ID",
        "visualization": { "id": "viz.billboard" },
        "layout": { "column": 1, "row": 1, "height": 3, "width": 4 },
        "title": "Updated Total Transaction Count",
        "linkedEntityGuids": [],
        "rawConfiguration": {
          "nrqlQueries": [
            {
              "accountIds": [1],
              "query": "SELECT count(*) FROM Transaction"
            }
          ]
        }
      },
      {
        "visualization": { "id": "viz.line" },
        "layout": { "column": 5, "row": 1, "height": 3, "width": 4 },
        "title": "New Line Chart",
        "rawConfiguration": {
          "nrqlQueries": [
            {
              "accountIds": [1],
              "query": "SELECT count(*) FROM PageView TIMESERIES"
            }
          ]
        }
      }
    ]
  }
}

Actualiza el widget en una página

Puede actualizar un conjunto de widgets existentes de una página dashboard dado un GUID de entidad de la página dashboard. Debes especificar el conjunto de widgets que se actualizarán y su configuración completa.

Importante

Esta operación no permite agregar o eliminar widgets de una página. Para agregar o eliminar un widget, emplee la operación Actualizar una página dashboard .

Vaya al explorador NerdGraph GraphiQL en api.newrelic.com/graphiql.
Emplee API dashboard de NerdGraph para obtener la configuración dashboard existente leyendo el dashboard por su GUID de entidad, como se muestra en la sección Leer un dashboard.
Identifique y extraiga el widget en la página que desea actualizar desde el dashboard.
Modifique los campos que desea actualizar en el widget.
Emplee dashboardUpdateWidgetsInPage() para modificar el widget.
Marque errors si hay alguno.

mutation UpdateWidgetsInPage(
  $pageGuid: EntityGuid!
  $widgets: [DashboardUpdateWidgetInput!]!
) {
  dashboardUpdateWidgetsInPage(guid: $pageGuid, widgets: $widgets) {
    errors {
      type
      description
    }
  }
}

Y aquí están las variables a emplear con esta mutación:

{
  "guid": "PAGE_GUID",
  "widgets": [
    {
      "id": "WIDGET_ID",
      "visualization": { "id": "viz.billboard" },
      "layout": { "column": 1, "row": 1, "height": 3, "width": 4 },
      "title": "Updated Total Transaction Count",
      "linkedEntityGuids": [],
      "rawConfiguration": {
        "nrqlQueries": [
          {
            "accountIds": [1],
            "query": "SELECT count(*) FROM Transaction"
          }
        ]
      }
    }
  ]
}

Otras operaciones

Operación	Tipo de operación GraphQL	Notas
`dashboardCreateSnapshotUrl()`	mutación	Crear operación de instantánea de la página dashboard. Puede crear una URL pública para un GUID de entidad de una página dashboard determinado. Luego se puede acceder a la página dashboard en forma de una instantánea estática en la URL pública resultante. La URL resultante quedará obsoleta tres meses luego de su creación. Consulte Gestionar instantáneas dashboard a través de API para obtener más información.
`actor > dashboard > liveUrls()`	consulta	Listar todas las operaciones de URL activas. Puede obtener la lista completa de URL activas a las que tiene acceso. Una URL en tiempo real es un mecanismo que le permite compartir páginas dashboard y widgets de forma pública con datos actualizados o en tiempo real. Consulte Gestionar URL de gráficos en tiempo real a través de API para obtener más información.
`dashboardWidgetRevokeLiveUrl()`	mutación	Revocar la operación de URL activa del widget. Puede revocar una URL activa de un widget creada previamente. Como resultado, la URL en tiempo real no estará disponible para el público. Consulte Gestionar URL de gráficos en tiempo real a través de API para obtener más información.
`dashboardCreateLiveUrl()`	mutación	Cree una URL dashboard en tiempo real de acceso público. Consulte Crear, actualizar y revocar URL de dashboards de uso compartido público para obtener más información.
`dashboardUpdateLiveUrl()`	mutación	Actualizar la fecha de vencimiento de una URL dashboard en tiempo real de acceso público. Consulte Crear, actualizar y revocar URL de dashboards de uso compartido público para obtener más información.
`dashboardRevokeLiveUrl()`	mutación	Revocar la URL dashboard en tiempo real de acceso público. Consulte Crear, actualizar y revocar URL de dashboards de uso compartido público para obtener más información.
`dashboardUpdateLiveUrlCreationPolicies()`	mutación	Sólo un administrador de dominio de autenticación puede usar esta mutación para habilitar o deshabilitar la política Live URL Creation para las cuentas. El usuario puede crear URL activas para el panel en cuentas donde esta política esté habilitada.

Dashboard entre cuentas

Con NerdGraph, puedes crear consultas de datos desde más de una cuenta New Relic. También puede crear un dashboard utilizando datos de varias cuentas agregando ID de cuenta a la matriz accountIds.

A continuación se muestra un ejemplo de creación de un dashboard entre cuentas:

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

Límites

Hemos limitado los valores que puede establecer para algunas de las propiedades dashboard . Esto nos permite mantener el dashboard en buen estado y al mismo tiempo mejorar su usabilidad.

Límites dashboard

Límite	Valor
Número máximo de páginas en un dashboard	25
Longitud máxima del nombre de un dashboard	255
Longitud máxima de una descripción dashboard	1024

Límites de la página dashboard

Límite	Valor
Número máximo de widgets en una página dashboard	150
Longitud máxima del nombre de una página dashboard	255
Longitud máxima de la descripción de una página dashboard	1024

Límite	Valor
Longitud máxima del título de un widget	255
Número máximo de entidades vinculadas a un widget	1
Número máximo de consultas en un widget	20
Columna de diseño máxima de un widget	12
Columna de diseño mínimo de un widget	1
Fila de diseño mínima de un widget	1
Ancho máximo de diseño de un widget	12
Ancho mínimo de diseño de un widget	1
Altura máxima de diseño de un widget	32
Altura mínima de diseño de un widget	1

Errores como ciudadanos de primera

Todas las mutaciones dashboard ofrecen una forma de solicitar errores al ejecutarse. Esto significa que puede realizar mutaciones dashboard y verificar la respuesta para detectar problemas potenciales esperados. Cada error tiene un tipo y una descripción para ayudarle a identificar cuál es el origen del problema.

Tenga en cuenta que se trata de errores esperados de los que conocemos de antemano. También debe verificar si hay errores inesperados que se devolverán en el campo de errores estándar de GraphQL.

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

Tutorial de NerdGraph: Crear y gestionar un panel de control

Descripción general

Operaciones CRUD dashboard

Crear un dashboard

Dashboard con una página, un widget y una variable

Crear dashboard empleando variables GraphQL

Leer un dashboard

Actualizar un dashboard

Importante

Importante

Actualizar dashboard mediante variables GraphQL

Eliminar un dashboard

Eliminar un dashboard

Recuperar un dashboard

Recuperar un dashboard

Operaciones de la página dashboard

Actualizar una página dashboard

Importante

Sugerencia

Actualizar una página

Actualizar una página agregando un nuevo widget

Actualiza el widget en una página

Importante

Otras operaciones

Dashboard entre cuentas

Dashboard con consulta entre cuentas

Límites

Límites dashboard

Límites de la página dashboard

Límites widget

Errores como ciudadanos de primera

Errores como parte de cada respuesta a una mutación.

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

Tutorial de NerdGraph: Crear y gestionar un panel de control

Descripción general .css-21sua1{background:none;border:none;width:0;padding:0;}

Operaciones CRUD dashboard

Crear un dashboard

Crear dashboard empleando variables GraphQL

Leer un dashboard

Actualizar un dashboard

Importante

Importante

Actualizar dashboard mediante variables GraphQL

Eliminar un dashboard

Eliminar un dashboard

Recuperar un dashboard

Recuperar un dashboard

Operaciones de la página dashboard

Actualizar una página dashboard

Importante

Sugerencia

Actualizar una página

Actualizar una página agregando un nuevo widget

Actualiza el widget en una página

Importante

Otras operaciones

Dashboard entre cuentas

Dashboard con consulta entre cuentas

Límites

Límites dashboard

Límites de la página dashboard

Límites widget

Errores como ciudadanos de primera

Errores como parte de cada respuesta a una mutación.

Descripción general