Neste documento, descrevemos como gerenciar monitores sintéticos. Você pode consultar uma lista dos monitores sintéticos e, para cada monitor sintético, acessar e modificar a configuração, visualizar o histórico de execução e detalhes sobre cada execução. Você pode gerenciar seus monitores sintéticos usando o console do Google Cloud ou a API Cloud Monitoring.
Para saber como analisar os resultados de execução e as métricas e os registros de um monitor sintético, consulte Analisar os resultados do monitor sintético.
Antes de começar
-
Para ter as permissões necessárias para acessar e modificar monitores sintéticos no console do Google Cloud, faça o seguinte: peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:
-
Editor do Monitoring (
roles/monitoring.editor
) -
Desenvolvedor do Cloud Functions (
roles/cloudfunctions.developer
)
Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.
Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou de outros papéis predefinidos.
-
Editor do Monitoring (
As instruções da API nesta página são para o APIs Explorer. No entanto, também é possível emitir um comando curl. O APIs Explorer fornece a sintaxe do curl.
Listar monitores sintéticos
Console
Para listar os monitores sintéticos no seu projeto do Google Cloud, faça o seguinte:
-
No console do Google Cloud, acesse Página Monitoramento sintético:
Acesse Monitoramento sintético
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Opcional: para restringir os monitores sintéticos que são listados, 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 monitor sintético ou uma correspondência parcial. As correspondências não diferenciam maiúsculas de minúsculas. Por exemplo, para listar todos os monitores sintéticos com nome que contém
default
, 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
.
A página Monitores sintéticos mostra o seguinte para cada monitor sintético:
- Status da execução mais recente.
- Um link para informações detalhadas sobre o monitor sintético.
- A taxa de sucesso e o tempo médio de execução.
- O número de políticas de alertas.
- Para editar, copiar ou excluir o monitor sintético e criar uma política de alertas, use o menu more_vert Mais opções.
gcloud
Para listar as verificações de tempo de atividade e os monitores sintéticos, execute o comando gcloud monitoring uptime list-configs
:
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 os monitores sintéticos no seu projeto do Google Cloud, incluindo
verificações de tempo de atividade, chame o método
projects.uptimeCheckConfigs.list
:
- Clique em
projects.uptimeCheckConfigs.list
. Usar a ferramenta APIs Explorer.
Defina o pai do método como o nome do projeto, verifique se você use o seguinte formato:
projects/PROJECT_ID
Na expressão anterior,
PROJECT_ID
é o ID do projeto do Google Cloud.
Para um monitor sintético, o resultado contém um campo identificado como syntheticMonitor
.
Mais detalhes de um monitor sintético
Console
Para conferir os detalhes de um monitor sintético no seu projeto do Google Cloud, faça o seguinte:
-
No console do Google Cloud, acesse a página Monitoramento sintético:
Acessar Monitoramento sintético
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Para abrir a página Detalhes do monitor sintético, localize o monitor sintético que você quer visualizar e clique no nome dele.
Se você quiser acessar a função do Cloud Run na página Detalhes das funções fornecida pelo Cloud Run functions, selecione a guia Code e clique no nome da função. A página Detalhes das funções é aberta em uma nova janela. As guias nessa página permitem que você veja métricas e registros, e informações de configuração.
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. Para encontrar o
identificador, execute o comando gcloud monitoring uptime list-configs
e
examine o campo name. Para mais informações, consulte
Encontre o identificador exclusivo de um monitor sintético.
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 um monitor sintético específico no seu projeto do Google Cloud, faça o seguinte:
chame o método
Método projects.uptimeCheckConfigs.get
:
- Clique em
projects.uptimeCheckConfigs.get
. Use o APIs Explorer.
Defina o pai do método como o identificador do monitor sintético. use o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior,
PROJECT_ID
é o ID do projeto do Google Cloud. eCHECK_ID
é o ID do monitor sintético.Por exemplo, o valor do campo pai pode ser:
projects/my-project/uptimeCheckConfigs/10863117100295372627
Para encontrar o valor de CHECK_ID, emita a
projects.uptimeCheckConfigs.list
. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtrodisplayName="MySyntheticMonitor"
.
Editar um monitor sintético ou uma função do Cloud Run
Console
Para editar um monitor sintético ou a função do Cloud Run usando a página Detalhes do monitor sintético, faça o seguinte:
-
No console do Google Cloud, acesse Página Monitoramento sintético:
Acessar Monitoramento sintético
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
- Localize o monitor sintético que você quer editar, clique em more_vert Mais opções e selecione Editar.
Opcional: para editar a função do Cloud Run, clique em Editar função, faça as alterações e clique em Aplicar função.
Para modificadores de links quebrados, para modificar o URI de origem ou as opções que definem quais links são testados, edite a função do Cloud Run e atualize o objeto
options
no arquivoindex.js
. Para informações sobre os campos e a sintaxe desse objeto, consultebroken-links-ok/index.js
Para manter as modificações, clique em Salvar. Caso contrário, clique em Cancelar.
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. 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 Encontrar o identificador exclusivo de uma verificação de tempo de atividade.Defina os campos que você quer modificar. Para monitores sintéticos, você pode atualize apenas os seguintes campos:
- Período
- Nome de exibição
- Tempo limite
- Identificadores do usuário
Por exemplo, para definir o período de um monitor sintético como 10 minutos, execute o seguinte comando:
gcloud monitoring uptime update CHECK_ID --period=10
API
As políticas e funções de alerta não são contidas por um monitor sintético e, portanto, não podem ser editadas pelo procedimento descrito nesta seção:
Para modificar uma política de alertas, use o console do Google Cloud ou chame o método
alertPolicies.patch
. Para mais informações, consulte Gerenciar políticas de alertas por API.Para modificar uma função do Cloud Run, depois de atualizar a origem da função você precisa reimplantá-la. Para mais informações, consulte Implantar uma função do Cloud Run.
Para editar um monitor sintético, chame o método
Método projects.uptimeCheckConfigs.patch
:
- Clique em
projects.uptimeCheckConfigs.patch
. Use o APIs Explorer.
Defina o pai do método como o identificador do monitor sintético. use o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior,
PROJECT_ID
é o ID do projeto do Google Cloud, eCHECK_ID
é o ID do monitor sintético.Para encontrar o valor do CHECK_ID, emita o método
projects.uptimeCheckConfigs.list
. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtrodisplayName="MySyntheticMonitor"
.Defina o parâmetro de consulta do método, updateMask, para identificar quais campos do objeto estão sendo modificados. Por exemplo, para atualizar valor de
displayName
, o parâmetro de consulta ficará assim:updateMask=displayName
Copiar um monitor sintético
Console
Para copiar um monitor sintético no seu projeto do Google Cloud, faça o seguinte:
-
No console do Google Cloud, acesse Página Monitoramento sintético:
Acesse Monitoramento sintético
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize o monitor sintético que você quer editar, clique em more_vert Mais opções e selecione Copiar.
A caixa de diálogo Copiar verificação sintética é aberta com os campos pré-preenchidos. incluindo uma cópia da função do Cloud Run.
Clique em Criar função, atualize conforme necessário e Clique em Aplicar função.
Para manter as modificações, clique em Criar. Caso contrário, clique em Cancelar.
Quando você clica em Criar, a função do Cloud Run é criada e implantada, e o monitor sintético é criado.
gcloud
Não há um método da CLI do Google Cloud que permita copiar um monitor sintético.
API
Não há um método de API que permita copiar um monitor sintético. No entanto, é possível fazer uma cópia seguindo estas etapas:
- Chame o método
projects.uptimeCheckConfigs.get
e salve a resposta. Para mais informações, consulte Veja os detalhes de um monitor sintético. - Edite a resposta.
- Chame o método
projects.uptimeCheckConfigs.create
e transmita ao método a resposta editada.
Excluir um monitor sintético
Console
Para excluir um monitor sintético e as políticas de alerta associadas, faça o seguinte:
-
No console do Google Cloud, acesse Página Monitoramento sintético:
Acesse Monitoramento sintético
Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Localize o monitor sintético que você quer excluir e clique no nome.
Opcional: se você quiser excluir a função do Cloud Run, selecione a guia Code e clique no nome da função. A página Detalhes das funções é aberta. em uma nova janela.
Na página Detalhes do monitor sintético, clique em
Excluir e conclua a caixa de diálogo.Você excluiu o monitor sintético.
Para excluir a função do Cloud Run, acesse a página Detalhes das funções. clique em
Excluir e preencha a caixa de diálogo.
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 pelo identificador da verificação de tempo de atividade ou do monitor sintético. Para encontrar o
identificador, execute o comando gcloud monitoring uptime list-configs
e
examine o campo name. Para mais informações, consulte
Encontre o identificador exclusivo de um monitor sintético.
API
Para excluir um monitor sintético e as políticas de alertas associadas, chame o método
Método projects.uptimeCheckConfigs.delete
:
- Clique em
projects.uptimeCheckConfigs.delete
. Usar a ferramenta APIs Explorer.
Defina o pai do método como o identificador do monitor sintético. use o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior,
PROJECT_ID
é o ID do projeto do Google Cloud. eCHECK_ID
é o ID do monitor sintético.Para encontrar o valor do CHECK_ID, emita o método
projects.uptimeCheckConfigs.list
. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtrodisplayName="MySyntheticMonitor"
.
Encontrar o identificador exclusivo de um monitor sintético
Quando o monitor sintético é criado, o Monitoring atribui a ele uma identificador. Esse identificador é incorporado no nome do recurso do monitor sintético e tem o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
O CHECK_ID está incluído na resposta da Google Cloud CLI e os métodos da API Cloud Monitoring que criam ou listam monitores sintéticos.