Monitoramento do Google Cloud

nota

Nas versões anteriores do Grafana, essa fonte de dados se chamava Google Stackdriver.

Adicione a fonte de dados do Google Cloud Monitoring para poder criar painéis para suas métricas do Google Cloud Monitoring.

Adicionar a fonte de dados

1. Abra o menu lateral escolhendo o ícone Grafana no cabeçalho superior.

2. No menu lateral, abaixo do link Painéis, você deve encontrar o link Fontes de dados.

3. Escolha o botão + Adicionar fonte de dados no cabeçalho superior.

4. Selecione Google Cloud Monitoring na lista suspensa Tipo.

5. Faça o upload ou cole no arquivo de chave da conta de serviço. Veja mais adiante neste documento as etapas para criar um arquivo de chave de conta de serviço.

nota

Se você não vê o link Fontes de dados no menu lateral, seu usuário atual não tem aAdmin função.

Name (Nome)	Descrição
Name	O nome da fonte de dados. É assim que você se refere à fonte de dados em painéis e consultas.
Default	A fonte de dados padrão significa que ela será pré-selecionada para novos painéis.
Service Account Key	Arquivo de chave da conta de serviço para um projeto do GCP. Veja as instruções mais adiante neste documento sobre como criá-lo.

Autenticação

Há duas maneiras de autenticar o plug-in do Google Cloud Monitoring

• Carregar um arquivo JWT do Google

• Recupere automaticamente as credenciais do servidor de metadados do Google

A última opção só está disponível ao executar o Grafana na máquina virtual GCE.

Usando um arquivo de chave da conta de serviço do Google

Para se autenticar com a Google Cloud Monitoring API, você deve criar uma conta de serviço do Google Cloud Platform (GCP) para o projeto para o qual deseja mostrar dados. Uma fonte de dados Grafana se integra a um projeto do GCP. Para visualizar dados de vários projetos do GCP, você deve criar uma fonte de dados por projeto do GCP.

Habilitando APIs

As seguintes APIs devem ser habilitadas primeiro:

• API de monitoramento

• API do Cloud Resource Manager

Escolha os links listados e selecione o botão Ativar.

Criação de uma conta de serviço do GCP para um projeto

1. Navegue até a página APIs e credenciais de serviços.

2. Escolha o botão suspenso Criar credenciais e escolha a opção Chave da conta de serviço.

   {{< docs-imagebox img=” /img/docs/v71/cloudmonitoring_create_service_account_button.png "class="docs-image—no-shadow” caption="botão Criar conta de serviço” >}}

3. Na página Criar chave da conta de serviço, escolha o tipo de chaveJSON. Em seguida, na lista suspensa Conta de serviço, escolha a opção Nova conta de serviço.

   {{< docs-imagebox img=” /img/docs/v71/cloudmonitoring_create_service_account_key.png "class="docs-image—no-shadow” caption="Criar chave da conta de serviço” >}}

4. Alguns novos campos aparecerão. Preencha um nome para a conta de serviço no campo Nome da conta de serviço e escolha a função Monitoring Viewer na lista suspensa Função.

   {{< docs-imagebox img=” /img/docs/v71/cloudmonitoring_service_account_choose_role.png "class="docs-image—no-shadow” caption="Escolha a função” >}}

5. Escolha o botão Criar. Um arquivo de chave JSON será criado e baixado para o seu computador. Armazene esse arquivo em um local seguro, pois ele permite o acesso aos seus dados do Google Cloud Monitoring.

6. Faça o upload para o Grafana na página de configuração da fonte de dados. Você pode carregar o arquivo ou colar no conteúdo do arquivo.

   {{< docs-imagebox img=” /img/docs/v71/cloudmonitoring_grafana_upload_key.png "class="docs-image—no-shadow” caption="Carregar arquivo de chave de serviço para o Grafana” >}}

7. O conteúdo do arquivo será criptografado e salvo no banco de dados Grafana. Não se esqueça de salvar depois de fazer o upload do arquivo!

   {{< docs-imagebox img=” /img/docs/v71/cloudmonitoring_grafana_key_uploaded.png "class="docs-image—no-shadow” caption="O arquivo da chave de serviço foi carregado para o Grafana” >}}

Usar o Query Editor

O editor de consultas do Google Cloud Monitoring permite que você crie dois tipos de consultas: métrica e objetivo de nível de serviço (SLO). Os dois tipos retornam dados de séries temporais.

Consultas métricas

O editor de consultas métricas permite que você selecione métricas, agrupe/agregue por rótulos e por tempo e use filtros para especificar quais séries temporais você deseja nos resultados.

Para criar uma consulta de métrica, siga estas etapas:

1. Escolha a opção Métricas na lista suspensa Tipo de consulta.

2. Escolha um projeto na lista suspensa Projeto.

3. Escolha um serviço do Google Cloud Platform na lista suspensa Serviço.

4. Escolha uma métrica na lista suspensa Métrica.

5. Para adicionar ou remover filtros ou agrupar por cláusulas, use os ícones de adição e subtração nas seções filtrar e agrupar por. Esta etapa é opcional.

As métricas do Google Cloud Monitoring podem ser de diferentes tipos (GAUGE, DELTA, CUMULATIVE) e essas métricas oferecem suporte para diferentes opções de agregação (redutores e alinhadores). O editor de consultas Grafana mostra a lista de métodos de agregação disponíveis para uma métrica selecionada e define um redutor e alinhador padrão quando você seleciona a métrica. As unidades do eixo Y também são selecionadas automaticamente pelo editor de consultas.

Filtros

Para adicionar um filtro, escolha o ícone de adição, escolha um campo para filtrar e insira um valor de filtro. Por exemplo, digite instance_name = grafana-1. Você pode remover o filtro escolhendo o nome do filtro e selecionando--remove filter--.

Caracteres curinga simples

Quando o operador está definido como ou,=!= é possível adicionar caracteres curinga ao campo de valor do filtro. Por exemplo,us-* captura todos os valores que começam com “us-” e*central-a captura todos os valores que terminam com “central-a”. *-central-*captura todos os valores que têm a substring decentral-. Caracteres curinga simples são mais baratos do que expressões regulares.

Expressões regulares

Quando o operador está definido como ou,=~!=~ é possível adicionar expressões regulares ao campo de valor do filtro. Por exemplo,us-central[1-3]-[af] combina todos os valores que começam com “us-central”, seguido por um número no intervalo de 1 a 3, um traço e depois um “a” ou um “f”. As barras à esquerda e à direita não são necessárias ao criar expressões regulares.

Agregação

O campo de agregação permite combinar séries temporais com base em estatísticas comuns. Para obter mais informações sobre agregação, consulte as opções de agregação.

OAligner campo permite alinhar várias séries temporais após o mesmo grupo por intervalo de tempo. Para obter mais informações sobre o alinhador, consulte seletor de métricas de alinhamento.

Período de alinhamento e agrupamento por tempo

OAlignment Period grupo agrupa uma métrica por tempo se uma agregação for escolhida. O padrão é usar os agrupamentos padrão do GCP Google Cloud Monitoring (que permitem comparar gráficos no Grafana com gráficos na interface do usuário do Google Cloud Monitoring). A opção é chamadacloud monitoring auto e os padrões são:

• 1m para intervalos de tempo < 23 horas

• 5m para intervalos de tempo >= 23 horas e < 6 dias

• 1h para intervalos de tempo >= 6 dias

A outra opção automática égrafana auto. Isso definirá automaticamente o grupo por hora, dependendo do intervalo de tempo escolhido e da largura do painel gráfico. Para obter mais informações, consulte Adicionar uma variável de intervalo.

Também é possível escolher intervalos de tempo fixos para agrupar, como1h ou1d.

Agrupar por

Agrupe por rótulos de recursos ou métricas para reduzir o número de séries temporais e agregar os resultados por um grupo por. Por exemplo, agrupe por instance_name para ver uma métrica agregada para uma instância de computação.

Rótulos de metadados

Os rótulos de metadados de recursos contêm informações para identificar de forma exclusiva um recurso no Google Cloud. Os rótulos de metadados só são retornados na resposta da série temporal se fizerem parte do segmento Agrupar por na solicitação de série temporal. Não há API para recuperar rótulos de metadados, portanto, não é possível preencher o grupo por lista suspensa com os rótulos de metadados que estão disponíveis para o serviço e a métrica selecionados. No entanto, a lista suspensa Agrupar por campo vem com uma lista predefinida de rótulos comuns do sistema.

Os rótulos do usuário não podem ser predefinidos, mas é possível inseri-los manualmente no campo Agrupar por. Se um rótulo de metadados, rótulo de usuário ou rótulo de sistema estiver incluído no segmento Agrupar por, você poderá criar filtros com base nele e expandir seu valor no campo Alias.

Padrões de aliases

O campo Alias By permite que você controle o formato das teclas de legenda. O padrão é mostrar o nome e os rótulos da métrica. Isso pode ser longo e difícil de ler. Usando os padrões a seguir no campo de alias, você pode formatar a chave da legenda da maneira que quiser.

Padrões de tipo métrico

Padrões de aliases	Descrição	Exemplo de resultado
{{metric.type}}	Retorna o tipo de métrica completo.	compute.googleapis.com/instance/cpu/utilization
{{metric.name}}	Retorna a parte do nome da métrica.	instance/cpu/utilization
{{metric.service}}	Devolve a peça de serviço.	compute

Padrões de etiqueta

Na lista suspensa Agrupar por, você pode ver uma lista de rótulos de métricas e recursos para uma métrica. Eles podem ser incluídos na chave da legenda usando padrões de aliases.

Formato padrão de alias	Descrição	Exemplo de padrão de alias	Exemplo de resultado
{{metric.label.xxx}}	Retorna o valor do rótulo métrico.	{{metric.label.instance_name}}	grafana-1-prod
{{resource.label.xxx}}	Retorna o valor do rótulo do recurso.	{{resource.label.zone}}	us-east1-b
{{metadata.system_labels.xxx}}	Retorna o valor do rótulo do sistema de metadados.	{{metadata.system_labels.name}}	grafana
{{metadata.user_labels.xxx}}	Retorna o valor do rótulo do usuário dos metadados.	{{metadata.user_labels.tag}}	production

Exemplo de alias por:{{metric.type}} - {{metric.label.instance_name}}

Exemplo de resultado:compute.googleapis.com/instance/cpu/usage_time - server1-prod

Também é possível resolver o nome do Tipo de Recurso Monitorado.

Formato padrão de alias	Descrição	Exemplo de resultado
{{resource.type}}	Retorna o nome do tipo de recurso monitorado.	gce_instance

Exemplo de alias por:{{resource.type}} - {{metric.type}}

Exemplo de resultado:gce_instance - compute.googleapis.com/instance/cpu/usage_time

Consultas de SLO

nota

As consultas SLO estão disponíveis somente no Grafana v7.0+

O criador de consultas SLO na fonte de dados do Google Cloud Monitoring permite que você exiba dados de SLO em formato de série temporal. Para entender os conceitos básicos do monitoramento de serviços, consulte a documentação oficial do Google Cloud Monitoring.

Criação de uma consulta de SLO

Para criar uma consulta de SLO, siga estas etapas:

1. Escolha a opção Objetivos de nível de serviço (SLO) na lista suspensa Tipo de consulta.

2. Escolha um projeto na lista suspensa Projeto.

3. Escolha um serviço de SLO na lista suspensa Serviço.

4. Escolha um SLO na lista suspensa de SLO.

5. Escolha um seletor de séries temporais na lista suspensa Seletor.

Os nomes amigáveis dos seletores de séries temporais são mostrados em Grafana. A tabela a seguir mostra o mapeamento do nome amigável para o nome do sistema usado na documentação do Service Monitoring.

Valor da lista suspensa do seletor	Seletor de série temporal correspondente usado
Valor SLI	select_slo_health
Compatibilidade com o SLO	select_slo_compliance
Erro de SLO: orçamento restante	select_slo_budget_fraction

Padrões de alias para consultas de SLO

Você pode usar o campo Alias By para controlar o formato das chaves de legenda para consultas de SLO.

Padrões de aliases	Descrição	Exemplo de resultado
{{project}}	Retorna o nome do projeto do GCP.	myProject
{{service}}	Devolve o nome do serviço.	myService
{{slo}}	Recupera o SLO.	latency-slo
{{selector}}	Retorna o seletor.	select_slo_health

Período de alinhamento e agrupamento por tempo para consultas de SLO

As consultas SLO usam a mesma funcionalidade de período de alinhamento das consultas métricas. Para obter mais informações, consulte Consultas métricas.

Modelagem

Em vez de codificar coisas como servidor, aplicativo e nome do sensor em suas consultas métricas, você pode usar variáveis em seu lugar. As variáveis são mostradas como caixas de seleção suspensas na parte superior do painel. Você pode usar essas caixas suspensas para alterar os dados exibidos em seu painel.

Para obter mais informações sobre modelagem e variáveis de modelo, consulteModelos e variáveis.

Variável de consulta

A variável do tipo Query permite que você consulte o Google Cloud Monitoring para vários tipos de dados. O plug-in de fonte de dados do Google Cloud Monitoring fornece o seguinteQuery Types.

Name (Nome)	Descrição
Metric Types	Retorna uma lista de nomes de tipos de métricas que estão disponíveis para o serviço especificado.
Labels Keys	Retorna uma lista de chaves parametric label eresource label na métrica especificada.
Labels Values	Retorna uma lista de valores para o rótulo na métrica especificada.
Resource Types	Retorna uma lista de tipos de recursos para a métrica especificada.
Aggregations	Retorna uma lista de agregações (redutores de série cruzada) para a métrica especificada.
Aligners	Retorna uma lista de alinhadores (por alinhadores de série) para a métrica especificada.
Alignment periods	Retorna uma lista de todos os períodos de alinhamento que estão disponíveis no editor de consultas do Google Cloud Monitoring no Grafana.
Selectors	Retorna uma lista de seletores que podem ser usados em consultas de SLO (Objetivos de Nível de Serviço).
SLO Services	Retorna uma lista de serviços de monitoramento de serviços que podem ser usados em consultas de SLO.
Service Level Objectives (SLO)	Retorna uma lista de SLOs para o serviço de SLO especificado.

Usar variáveis em consultas

Há duas sintaxes:

• $<varname> Exemplo: metric.label.$metric_label

• [[varname]] Exemplo: metric.label.[[metric_label]]

Por que duas maneiras? A primeira sintaxe é mais fácil de ler e escrever, mas não permite que você use uma variável no meio de uma palavra. Quando as opções Multivalor ou Incluir todos os valores estão habilitadas, o Grafana converte os rótulos de texto simples em uma string compatível com regex, o que significa que você precisa usar=~ em vez de=.

Anotações

Você pode usar anotações para sobrepor informações ricas sobre eventos em cima dos gráficos. Você adiciona consultas de anotação por meio do menu Dashboard /Visualização de anotações. A renderização de anotações é cara, por isso é importante limitar o número de linhas retornadas. Ainda não há suporte para mostrar anotações e eventos do Google Cloud Monitoring, mas funciona bem com métricas personalizadas no Google Cloud Monitoring.

Para obter mais informações sobre anotações, consulteAnotações.

Com o editor de consultas para anotações, você pode selecionar uma métrica e filtros. Os campos Título e Texto oferecem suporte à modelagem e podem usar dados retornados da consulta. Por exemplo, o campo Título pode ter o seguinte texto:

{{metric.type}} has value: {{metric.value}}

Exemplo de resultado:monitoring.googleapis.com/uptime_check/http_status has this value: 502

Padrões para o editor de consulta de anotações

Formato padrão de alias	Descrição	Exemplo de padrão de alias	Exemplo de resultado
{{metric.value}}	Valor da métrica/ponto.	{{metric.value}}	555
{{metric.type}}	Retorna o tipo de métrica completo.	{{metric.type}}	compute.googleapis.com/instance/cpu/utilization
{{metric.name}}	Retorna a parte do nome da métrica.	{{metric.name}}	instance/cpu/utilization
{{metric.service}}	Devolve a peça de serviço.	{{metric.service}}	compute
{{metric.label.xxx}}	Retorna o valor do rótulo métrico.	{{metric.label.instance_name}}	grafana-1-prod
{{resource.label.xxx}}	Retorna o valor do rótulo do recurso.	{{resource.label.zone}}	us-east1-b

Vinculação profunda dos painéis do Grafana ao Metrics Explorer no Google Cloud Console

nota

Esse recurso está disponível somente para consultas métricas.

Escolha uma série temporal no painel para ver um menu de contexto com um link para Exibir no Metrics Explorer no Google Cloud Console. A escolha desse link abre o Metrics Explorer no Google Cloud Console e executa a consulta no painel Grafana. O link leva o usuário primeiro ao Seletor de Conta do Google. Depois de selecionar uma conta com sucesso, o usuário é redirecionado para o Metrics Explorer. O link fornecido é válido para qualquer conta, mas só exibirá a consulta se sua conta tiver acesso ao projeto do GCP especificado na consulta.