Neste documento, descrevemos como gerenciar as verificações de tempo de atividade usando o Console do Google Cloud, a Google Cloud CLI, a API Cloud Monitoring e o cliente bibliotecas.
Listar todas as verificações de tempo de atividade
Console
-
No console do Google Cloud, acesse a página
Verificações de tempo de atividade:
Acesse Verificações de tempo de atividade
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Veja no exemplo a seguir uma amostra da página Verificações de tempo de atividade:
(Opcional) Para restringir as verificações de tempo de atividade listadas, adicione filtros.
Cada filtro é composto por um nome e um valor. É possível definir o valor como uma correspondência exata para um nome de verificação de tempo de atividade ou uma correspondência parcial. As correspondências não diferenciam maiúsculas de minúsculas. Por exemplo, para listar todas as verificações de tempo de atividade que tem
default
em seu nome, faça o seguinte:- Clique em Filtrar tabela e selecione Exibir nome.
- Digite
default
e pressione a tecla Enter.
Se você tiver vários filtros, os filtros serão unidos automaticamente por um
AND
lógico, a menos que você insira um filtroOR
. O exemplo anterior usa o filtroOR
para que uma verificação de tempo de atividade seja listado se o nome corresponder adefault
ouTesting check
.
gcloud
Para listar suas verificações de tempo de atividade e monitores sintéticos, execute
gcloud monitoring uptime list-configs
comando:
gcloud monitoring uptime list-configs
Os dados retornados incluem o seguinte:
- Nome e nome de exibição.
- Verificar identificador.
- Recurso monitorado.
- Período entre as verificações.
É possível configurar o comando da Google Cloud CLI para filtrar e classificar os resultados.
API
Para listar suas verificações de tempo de atividade e monitores sintéticos, chame o método
projects.uptimeCheckConfigs.list
. Especifique os parâmetros a seguir:
parent: o projeto com as verificações de tempo de atividade que você quer listar. O formato é:
projects/PROJECT_ID
Para receber uma verificação de tempo de atividade específica, chame o método projects.uptimeCheckConfigs.get
. Especifique o parâmetro a seguir:
name: o nome completo da configuração da verificação de tempo de atividade.
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Para mais informações sobre o identificador de verificação de tempo de atividade, consulte Encontre o identificador exclusivo de uma verificação de tempo de atividade.
C#
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Mais detalhes de uma verificação de tempo de atividade
Console
-
No console do Google Cloud, acesse a página
Verificações de tempo de atividade:
Acesse Verificações de tempo de atividade
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize a verificação de tempo de atividade que você quer visualizar e clique no nome dela.
Veja na captura de tela a seguir os detalhes do tempo de atividade de uma verificação chamada "My Uptime Check":
A página Detalhes do tempo de atividade contém as seguintes informações:
- O intervalo de tempo selecionado. Por padrão, ele é de uma hora.
- O nome da verificação de tempo de atividade. Na amostra, ele é My Uptime Check.
- Os rótulos adicionados à verificação de tempo de atividade.
A porcentagem de tempo de atividade e a latência média. O valor de Percent uptime é uma porcentagem calculada como
(S/T)*100
, em queS
é o número de respostas de verificação bem-sucedidas, eT
é o número total de respostas de verificação em todos os locais. Para verificações de grupo, os valores deS
eT
são somados em todas as participantes do grupo.Por exemplo, durante 25 minutos, uma verificação de tempo de atividade com um período de 1 minuto executada em todas as regiões recebe 25 solicitações de cada um dos seis locais. O total é de 150 solicitações. Se o painel informar um tempo de atividade de 83,3%, 125 das 150 solicitações serão bem-sucedidas.
Os painéis Passed checks e Uptime check latency exibem gráficos do número de verificações aprovadas e a latência de cada verificação como uma função de tempo.
O painel Current Status exibe o status das verificações mais recentes. Um círculo verde com uma marca ao lado de uma região indica que a última execução da verificação nessa região foi bem-sucedida. Já um círculo vermelho com um x indica falha.
O painel Configuration mostra a configuração da verificação de tempo de atividade. Esses dados são atribuídos quando a verificação de tempo de atividade é criada. O valor de Check Id corresponde ao
CHECK_ID
das chamadas de API.O painel Políticas de alerta lista informações sobre políticas de e políticas de alertas. No painel de amostra, uma política de alertas é configurada.
gcloud
Para listar os detalhes de uma verificação de tempo de atividade ou monitor sintético,
executar gcloud monitoring uptime describe
comando:
gcloud monitoring uptime describe CHECK_ID
Antes de executar o comando anterior, substitua CHECK_ID por
o identificador da verificação de tempo de atividade ou do monitor sintético. Você encontra
identificador executando o comando gcloud monitoring uptime list-configs
e
examine o campo name. Para mais informações, consulte
Encontre o identificador exclusivo de uma verificação de tempo de atividade.
Os dados retornados para a verificação de tempo de atividade incluem o seguinte:
- Nome e nome de exibição.
- Verificar identificador.
- Recurso monitorado.
- Período entre as verificações.
API
Para listar os detalhes de uma verificação de tempo de atividade ou de um monitor sintético, chame o método
projects.uptimeCheckConfigs.get
. Especifique o parâmetro a seguir:
name: o nome completo da configuração da verificação de tempo de atividade.
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Para mais informações sobre o identificador de verificação de tempo de atividade, consulte Encontre o identificador exclusivo de uma verificação de tempo de atividade.
C#
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Editar uma verificação de tempo de atividade
É possível modificar alguns campos de uma verificação de tempo de atividade. Por exemplo, talvez você queira que a verificação ocorra com mais frequência, ou você pode querer aumentar o tempo limite associado à validação da resposta. No entanto, se seus a verificação de tempo de atividade não está configurada com o protocolo, tipo de recurso ou recurso, exclua a verificação de tempo de atividade atual e crie uma nova.
Para saber como editar uma política de alertas que monitora um verificação de tempo de atividade, consulte os documentos a seguir:
Para editar uma verificação de tempo de atividade pública, use o processo em qualquer uma das seguintes opções guias. Para editar uma verificação de tempo de atividade particular, use a guia Console ou API:
Console
-
No console do Google Cloud, acesse a página
Verificações de tempo de atividade:
Acesse Verificações de tempo de atividade
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize a verificação de tempo de atividade que você quer editar e siga um destes procedimentos:
- Clique em Mais more_vert e selecione Editar.
- Veja os detalhes da verificação de tempo de atividade e clique em Edit.
Altere os valores dos campos conforme necessário. Não é possível modificar todos os campos. Se os valores de cabeçalho personalizados de uma verificação estiverem ocultos, não será possível exibi-los.
Para conferir se a verificação funciona, clique em Testar. Se o teste falhar, consulte Verificações com falha para conferir as possíveis causas.
Clique em Salvar.
gcloud
Para modificar uma verificação de tempo de atividade ou um monitor sintético,
executar gcloud monitoring uptime update
comando:
gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS
Antes de executar o comando anterior, faça o seguinte:
Substitua CHECK_ID pelo identificador da verificação de tempo de atividade ou monitor sintético. Para encontrar o identificador, execute o comando o comando
gcloud monitoring uptime list-configs
e examine o campo name. Para mais informações, consulte Encontre o identificador exclusivo de uma verificação de tempo de atividade.Defina os campos que você quer modificar.
Por exemplo, para definir o período de uma verificação de tempo de atividade como 10 minutos, execute o seguinte comando:
gcloud monitoring uptime update CHECK_ID --period=10
API
Chame o método projects.uptimeCheckConfigs.patch
. Defina os parâmetros do método da seguinte maneira:
uptimeCheckConfig.name: obrigatório. Ele faz parte do URL REST. É o nome do recurso da verificação de tempo de atividade a ser editado:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Para mais informações sobre o identificador de verificação de tempo de atividade, consulte Encontre o identificador exclusivo de uma verificação de tempo de atividade.
updateMask: opcional. Este é um parâmetro de consulta:
?updateMask=[FIELD_LIST]
.[FIELD_LIST]
é uma lista separada por vírgulas dos campos no objetoUptimeCheckConfig
que precisam ser alterados. Exemplo:"resource.type,httpCheck.path"
O corpo da solicitação precisa conter um objeto
UptimeCheckConfig
com os novos valores de campo.
Se updateMask
estiver definido, somente os campos listados em updateMask
substituirão os campos correspondentes na configuração atual. Se um campo tiver subcampos e estiver listado na máscara, mas nenhum dos subcampos estiver, todos os subcampos dele substituirão os campos correspondentes.
Se updateMask
não estiver definido, a configuração no corpo da solicitação substituirá toda a configuração atual.
O método patch
retorna o objeto UptimeCheckConfig
da configuração alterada.
C#
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Pode haver um atraso de até cinco minutos antes que você veja os resultados da nova verificação de tempo de atividade. Durante esse tempo, os resultados da verificação anterior são exibidos nos painéis e usados nas políticas de alertas.
Excluir uma verificação de tempo de atividade
Recomendamos que você exclua uma verificação de tempo de atividade ao desativar o serviço ou recurso monitorado. Observação: antes de excluir uma verificação de tempo de atividade, confira se não há alertas políticas que monitoram a verificação de tempo de atividade. Quando uma política de alertas monitora uma verificação de tempo de atividade, o console do Google Cloud impede a exclusão desse tempo verificação. No entanto, a API Cloud Monitoring não gera um erro nem impede exclusão. Nenhum incidente é criado para a verificação ausente.
Para excluir uma verificação de tempo de atividade, siga estas etapas:
Console
-
No console do Google Cloud, acesse a página
Verificações de tempo de atividade:
Acesse Verificações de tempo de atividade
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize a verificação de tempo de atividade que você quer editar e siga um destes procedimentos:
- Clique em Mais more_vert e selecione Excluir.
- Visualize os detalhes da verificação de tempo de atividade e clique em Excluir
gcloud
Para excluir uma verificação de tempo de atividade ou monitor sintético,
executar gcloud monitoring uptime delete
comando:
gcloud monitoring uptime delete CHECK_ID
Antes de executar o comando anterior, substitua CHECK_ID por
o identificador da verificação de tempo de atividade ou do monitor sintético. Você encontra
identificador executando o comando gcloud monitoring uptime list-configs
e
examine o campo name. Para mais informações, consulte
Encontre o identificador exclusivo de uma verificação de tempo de atividade.
API
Para excluir uma verificação de tempo de atividade ou um monitor sintético, chame o método
projects.uptimeCheckConfigs.delete
. Preencha o parâmetro da seguinte maneira:
name: obrigatório. É o nome do recurso da configuração de verificação de tempo de atividade a ser excluída:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Para mais informações sobre o identificador de verificação de tempo de atividade, consulte Encontre o identificador exclusivo de uma verificação de tempo de atividade.
C#
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Java
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Go
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Node.js
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
PHP
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Python
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Ruby
Para autenticar no Monitoring, configure o Application Default Credentials. Para mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local.
Monitorar uma verificação de tempo de atividade
Recomendamos criar uma política de alertas para receber notificações quando a verificação de tempo de atividade falhar. Para mais informações, consulte Criar políticas de alertas para verificações de tempo de atividade.
Encontrar o identificador exclusivo de uma verificação de tempo de atividade
Quando a verificação de tempo de atividade é criada, o Monitoring atribui a ela conhecido como ID de verificação de tempo de atividade. Esse identificador está incorporado o nome do recurso para a verificação de tempo de atividade:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
O ID de verificação de tempo de atividade é incluído na resposta dos métodos da API Cloud Monitoring que criam ou listam verificações de tempo de atividadee. Também é possível encontrar o ID de verificação de tempo de atividade no painel Configuração da página Detalhes do tempo de atividade, na console do Google Cloud. Para informações sobre como exibir o tempo de atividade detalhes, consulte a seção Visualizar detalhes de uma verificação de tempo de atividade do este documento.
A seguir
- Listar endereços IP do servidor de verificação de tempo de atividade
- Criar políticas de alertas para verificações de tempo de atividade
- Gráfico com métricas de verificação de tempo de atividade