Código Google: Usar a API Dashboard para criar um painel de monitoramento próprio

Usar a API Dashboard para criar um painel de monitoramento próprio

28/04/2020

code { background-color: transparent }

A utilização de painéis no Cloud Monitoring facilita o acompanhamento de métricas importantes do sistema. Criar esses painéis de maneira manual na IU do Monitoring pode ser um processo demorado, principalmente se você quiser usá-los em diversos espaços de trabalho.
Com o recente anúncio de lançamento da API Dashboards do Cloud Monitoring, agora é possível criar os painéis de forma programática. Você pode criar um painel na IU do Monitoring, além de usar a API Dashboards para fazer o download da configuração JSON e, em seguida, criar um painel em outro espaço de trabalho usando essa configuração.

A API Dashboards do Monitoring

A API Cloud Monitoring oferece um recurso chamado projects.dashboards que tem um conjunto conhecido de métodos: “create”, “delete”, “get”, “list” e “patch”. A REST API aceita payloads JSON, que podem ser usados para criar painéis e atualizar ou excluir painéis existentes. Para usar a API, é necessário um conhecimento básico dos painéis do Cloud Monitoring. Ao ler a seção Criação de gráficos nos documentos, você poderá ver detalhes sobre a criação de painéis no console do Monitoring.

O payload JSON do painel

Para criar um painel por meio da API Dashboards, é necessário definir vários objetos nos dados do payload JSON. Essa parte é fácil se você chamar a API para exportar a configuração JSON de um painel atual.
Veja este exemplo de payload JSON:

Há várias estruturas no modelo de dados do painel para se entender:

displayName — o nome legível do painel
gridLayout, rowLayout, columnLayout — o contêiner para os widgets
widgets — o contêiner para os itens do gráfico
xyCharts — um modelo de gráfico que mostra os dados em um plano 2D (eixos X e Y)
dataSets — os dados para o objeto do gráfico, que contém os detalhes usados para coletar as informações específicas em um objeto timeSeriesFilter, inclusive o nome da métrica, os filtros dela e como ela está agregada.
xAxis, yAxis — definições que afetam a apresentação dos eixos
chartOptions — definições que afetam o modo do gráfico

Como criar facilmente o payload JSON do painel

Uma abordagem simples para criar uma configuração de painel é, primeiramente, usar o console do Cloud Monitoring para criar um painel e depois utilizar a API Dashboards para exportar a configuração JSON. Após a exportação, é possível compartilhar a configuração como um modelo pelo controle de origem ou da forma como você normalmente compartilha arquivos com seus colegas.
A API Dashboards oferece um método create e um método get. Para criar um painel do zero no JSON, é necessário conhecimento detalhado do modelo de dados da API e da sintaxe JSON correspondente. Uma abordagem muitos mais simples é criar a configuração JSON do painel na seção “Painéis” da IU do Cloud Monitoring e usar a API para exportar a representação JSON do painel. Após ter o JSON, é possível usar o método create para criar outro painel com base no JSON.

Criação de um painel de exemplo

Há muitas formas de chamar a API Cloud Monitoring. Uma maneira fácil de testar chamadas de API é usar a funcionalidade “Testar esta API” diretamente no método projects.dashboards.create. Será necessário ter um espaço de trabalho do Cloud Monitoring definido e o código do projeto GCP que contém esse espaço.
Criamos um exemplo de painel JSON com seis gráficos diferentes, monitoramento de um canal de dados com o Pub/Sub, Dataflow e componentes do BigQuery. É possível usar esse payload JSON como modelo para seu próprio painel.
1. Crie o painel e clique no botão azul “Testar” para abrir o recurso “Testar esta API” no lado direito do método projects.dashboards.create.
2. Digite um valor para o formulário de entrada pai no campo “projects/YOUR_PROJECT_ID” padrão, substituindo o código do seu projeto do GCP, que contém o espaço de trabalho do Cloud em que você quer criar o painel pelo valor da string “YOUR_PROJECT_ID”.
3. Destaque os valores padrão no formulário de entrada “Corpo da solicitação” e copie/cole a configuração JSON para o painel.

4. Na parte inferior da página, clique no botão “Executar”. Se tudo der certo, será exibido um código de resposta HTTP “200” na cor verde, além da descrição JSON do painel recém-criado.

5. Abra a seção “Painéis” no console do Cloud Monitoring para verificar o painel criado. Encontre o item “Data Processing Dashboard Template” e clique no nome para abrir o painel.

Se você já implantou recursos do Pub/Sub, do Dataflow e do BigQuery, serão exibidos valores no painel.

Exportação de um painel atual

Um caso de uso comum dessa API é para exportar configurações de painéis atuais, que podem ser usadas para criar um painel em outro espaço de trabalho. Para exportar a configuração, chame o método projects.dashboards.get com o nome do painel.
1. Abra a documentação da API projects.dashboards.get e clique no botão azul “Testar”, que abre o recurso “Testar esta API” no lado direito da página.
2. Digite um valor para o formulário de entrada pai no “projects/YOUR_PROJECT_ID/dashboards/YOUR_DASHBOARD_ID” padrão, substituindo o código do projeto host do espaço de trabalho em que você quer criar o painel pelo valor da string “YOUR_PROJECT_ID” e seu código do painel pelo valor da string “YOUR_DASHBOARD_ID”.
É possível localizar o código do painel no URL ao visualizá-lo na IU do Monitoring. Veja este exemplo.
https://console.cloud.google.com/monitoring/dashboards/custom/e6ee2110-efc0-431e-bc1a-ce2600a207bc?project=YOUR_PROJECT_ID
Caso você não tenha o código do painel, chame o método projects.dashboards.list, que retornará uma lista de todos os seus painéis. A configuração do painel pode ser extraída da lista por meio da localização do valor “Data Processing Dashboard” correspondente no displayName da configuração JSON.
3. Na parte inferior da página, clique no botão “Executar”. Se tudo der certo, será exibido um código de resposta HTTP “200” na cor verde, além da descrição JSON do painel recém-criado. O snippet JSON abaixo mostra o nome do painel que será necessário para a próxima chamada de API.

4. Salve essa configuração JSON como um arquivo. Para usá-la na criação de um novo painel, é necessário fazer três alterações na configuração JSON:
a. Remova o par de chave-valor “name”
b. Remova o par de chave-valor “etag”
c. Atualize a chave-valor “displayName” para refletir o nome do seu novo painel
5. Abra a documentação da API projects.dashboards.create e clique no botão azul “Testar”, que abre o recurso “Testar esta API” no lado direito da página.
6. Digite um valor para o formulário de entrada pai no campo “projects/YOUR_PROJECT_ID” padrão, substituindo o código do seu projeto do GCP, que contém o espaço de trabalho do Cloud em que você quer criar o painel pelo valor da string “YOUR_PROJECT_ID”.
7. Na parte inferior da página, clique no botão “Executar”. Se tudo der certo, será exibido um código de resposta HTTP “200” na cor verde, além da descrição JSON do painel recém-criado. O snippet JSON abaixo mostra o nome do painel que será necessário para a próxima chamada de API.

Como tornar a API ainda mais útil

Teste outros exemplos de configurações do painel e leia mais sobre a API na documentação Gerenciamento de painéis. Estamos trabalhando em recursos para tornar a API ainda mais útil, inclusive por meio da linha de comando do gcloud. Além disso, os colaboradores estão discutindo e planejando o módulo Terraform para a API Monitoring Dashboard no github. Como sempre, será ótimo receber sua opinião no formulário de feedback do Console do Cloud.

Nenhum comentário :

Postar um comentário

Usar a API Dashboard para criar um painel de monitoramento próprio

Nenhum comentário :

Labels

Archive

Feed