Você pode usar nossa API NerdGraph para criar e gerenciar .
Visão geral
Para obter uma introdução ao nosso recurso personalizado do painel, consulte a documentação do painel.
Ao usar o NerdGraph para configurar o painel, é útil entender que nossos painéis são considerados entidade, que possuem seus próprios IDs de entidade, semelhantes a outras coisas que consideramos entidade, como aplicativos de monitoramento, hosts e serviços.
Para saber como adicionar e configurar widgets e gráficos em um dashboard, consulte Configurar gráficos e outros widgets.
Operações
Definimos uma API GraphQL granular que permite executar diferentes operações dashboard dependendo de seu objetivo e escopo.
Operações CRUD dashboard
Aqui estão as operações relacionadas à criação, leitura, atualização e exclusão (CRUD).
| Operação | Tipo de operação GraphQL | Notas |
|---|---|---|
actor > entity() | consulta | Obtenha operação dashboard . Você pode obter todos os dados dashboard e do widget para um determinado GUID de entidade dashboard . |
dashboardCreate() | mutação | Criar operação dashboard . Você pode criar um dashboard anexado a uma conta específica especificando todos os seus elementos, desde metadados até configuração de widget. |
dashboardUpdate() | mutação | Atualize a operação dashboard . Você pode atualizar um dashboard existente com base em um GUID de entidade dashboard . Você precisa especificar os elementos completos e atualizados dashboard , desde os metadados até a configuração do widget. |
dashboardDelete() | mutação | Excluir operação dashboard . Você pode excluir um dashboard existente com base em um GUID de entidade dashboard . Esta operação executa uma exclusão lógica que permite recuperar seu dashboard. |
dashboardUndelete() | mutação | Operação de recuperação dashboard . Você pode recuperar um dashboard excluído anteriormente com base em um GUID de entidade dashboard . A tag personalizada não pode ser recuperada. |
Operações da página dashboard
| Operação | Tipo de operação GraphQL | Notas |
|---|---|---|
dashboardUpdatePage() | mutação | Atualize a operação da página dashboard . Você pode atualizar uma página de um dashboard existente com base no GUID da entidade da página dashboard . Você precisa especificar o elemento de página dashboard completo e atualizado, desde os metadados até a configuração do widget. |
dashboardUpdateWidgetsInPage() | mutação | Atualize a operação do widget. Você pode atualizar um conjunto de widgets existentes de uma página dashboard com base em um GUID de entidade da página dashboard . Você precisa especificar o conjunto de widgets a serem atualizados e sua configuração completa. |
dashboardAddWidgetsToPage() | mutação | Adicionar operação de widget. Você pode adicionar um conjunto de novos widgets a uma página dashboard com base em um GUID de entidade da página dashboard . Você precisa especificar o conjunto de novos widgets e sua configuração completa. |
Outras operações
| Operação | Tipo de operação GraphQL | Notas |
|---|---|---|
dashboardCreateSnapshotUrl() | mutação | Crie uma operação de instantâneo da página dashboard . Você pode criar uma URL pública para um determinado GUID de entidade de página dashboard . A página dashboard pode então ser acessada na forma de um instantâneo estático na URL pública resultante. |
actor > dashboard > liveUrls() | consulta | Liste todas as operações de URLs ativos. Você pode obter a lista completa de URLs ativos aos quais tem acesso. Um URL ativo é um mecanismo que permite compartilhar páginas dashboard e widgets publicamente com dados atualizados ou ativos. |
dashboardWidgetRevokeLiveUrl() | mutação | Revogar operação de URL ativa do widget. Você pode revogar um URL ativo de um widget criado anteriormente. Como resultado, o URL ativo ficará indisponível ao público. |
Painel entre contas
Com o NerdGraph, você pode criar consultas de dados de mais de uma conta New Relic. Você também pode criar um dashboard usando dados de várias contas adicionando IDs de contas à matriz accountIds.
Aqui está um exemplo de criação de um dashboard entre contas:
Limites
Limitamos os valores que você pode definir para algumas propriedades do dashboard . Isso nos permite manter o painel em bom estado e, ao mesmo tempo, aumentar sua usabilidade.
Limites dashboard
| Limite | Valor |
|---|---|
| Número máximo de páginas em um dashboard | 25 |
| Comprimento máximo do nome de um dashboard | 255 |
| Comprimento máximo de uma descrição dashboard | 1024 |
Limites de páginas dashboard
| Limite | Valor |
|---|---|
| Número máximo de widgets em uma página dashboard | 150 |
| Comprimento máximo do nome de uma página dashboard | 255 |
| Comprimento máximo da descrição de uma página dashboard | 1024 |
Limites widget
| Limite | Valor |
|---|---|
| Comprimento máximo do título de um widget | 255 |
| Número máximo de entidades vinculadas a um widget | 1 |
| Número máximo de consultas em um widget | 20 |
| Coluna máxima de layout de um widget | 12 |
| Coluna mínima de layout de um widget | 1 |
| Linha mínima de layout de um widget | 1 |
| Largura máxima de layout de um widget | 12 |
| Largura mínima de layout de um widget | 1 |
| Altura máxima do layout de um widget | 32 |
| Altura mínima do layout de um widget | 1 |
Erros como cidadãos de primeira classe
Todas as mutações dashboard oferecem uma maneira de solicitar erros ao serem executadas. Isso significa que você pode realizar alterações dashboard e verificar a resposta para detectar possíveis problemas esperados. Cada erro tem um tipo e uma descrição para ajudá-lo a identificar qual é a origem do problema.
Tenha em mente que estes são erros esperados dos quais estamos cientes antecipadamente. Você também deve verificar se há erros inesperados que serão retornados no campo de erros padrão do GraphQL.