Este documento descreve como gerenciar seus monitores sintéticos. É possível conferir uma lista dos seus monitores sintéticos e, para cada um deles, ver e modificar a configuração, o histórico de execução e os detalhes de cada execução. É possível gerenciar os monitores sintéticos usando o console Google Cloud ou a API Cloud Monitoring.
Para informações sobre como analisar os resultados da execução e as métricas e registros de um monitor sintético, consulte Analisar resultados de monitor sintético.
Esse recurso só é compatível com projetos Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
Antes de começar
Conclua as seguintes etapas no projeto do Google Cloud que armazena seu monitor sintético:
-
Para ter as permissões necessárias para visualizar e modificar monitores sintéticos usando o console Google Cloud , 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 curl.
-
Select the tab for how you plan to use the samples on this page:
Console
When you use the Google Cloud console to access Google Cloud services and APIs, you don't need to set up authentication.
gcloud
-
No console 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 Monitoring.
- Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
Opcional: para restringir os monitores sintéticos 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 cujo nome 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 listada caso seu nome corresponda adefault
ouTesting check
.- Status da execução mais recente.
- Um link para informações detalhadas sobre esse 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.
- PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- Nome e nome de exibição.
- Verifique o identificador.
- Recurso monitorado.
- Período entre as verificações.
- Clique em
projects.uptimeCheckConfigs.list
. Use o APIs Explorer.
Defina o parent do método como o nome do projeto e use o seguinte formato:
projects/PROJECT_ID
Na expressão anterior,
PROJECT_ID
é o ID do seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.-
No console 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 Monitoring.
- Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
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 quiser ver a função do Cloud Run na página Detalhes da função fornecida pelo Cloud Run functions, selecione a guia Código e clique no nome da função. A página Detalhes da função é aberta em uma nova janela. As guias nesta página permitem visualizar métricas e registros, além de informações de configuração.
- PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- CHECK_ID: 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 Encontrar o identificador exclusivo de um monitor sintético. - Nome e nome de exibição.
- Verifique o identificador.
- Recurso monitorado.
- Período entre as verificações.
- Clique em
projects.uptimeCheckConfigs.get
. Use o APIs Explorer.
Defina o parent do método como o identificador do monitor sintético e use o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior:
- PROJECT_ID é o ID do projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- CHECK_ID é o ID do monitor sintético.
Por exemplo, o valor do campo principal pode ser:
projects/my-project/uptimeCheckConfigs/10863117100295372627
Para encontrar o valor de 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"
.-
No console 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 Monitoring.
- Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- 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 mudanças e clique em Aplicar função.
Para verificadores de links quebrados, edite a função do Cloud Run e atualize o objeto
options
no arquivoindex.js
para modificar o URI de origem ou as opções que definem quais links são testados. 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.
- PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
CHECK_ID: 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 Encontrar o identificador exclusivo de uma verificação de tempo de atividade.Defina os campos que você quer modificar. Para monitores sintéticos, só é possível atualizar os seguintes campos:
- Período
- Nome de exibição
- Tempo limite
- Identificadores do usuário
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, é necessário reimplantá-la. Para mais informações, consulte Implantar uma função do Cloud Run.
- Clique em
projects.uptimeCheckConfigs.patch
. Use o APIs Explorer.
Defina o parent do método como o identificador do monitor sintético. O identificador tem o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior:
- PROJECT_ID é o ID do projeto; Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- CHECK_ID é o ID do monitor sintético.
Para encontrar o valor de 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 no objeto estão sendo modificados. Por exemplo, para atualizar o valor de
displayName
, o parâmetro de consulta é o seguinte:updateMask=displayName
-
No console 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 Monitoring.
- Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
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 campos pré-preenchidos, incluindo uma cópia da função do Cloud Run.
Clique em Criar função, atualize a função 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.
- Chame o método
projects.uptimeCheckConfigs.get
e salve a resposta. Para mais informações, consulte Ver detalhes de um monitor sintético. - Edite a resposta.
- Chame o método
projects.uptimeCheckConfigs.create
e transmita a resposta editada. -
No console 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 Monitoring.
- Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
Localize o monitor sintético que você quer excluir e clique no nome dele.
Opcional: se quiser excluir a função do Cloud Run, selecione a guia Código e clique no nome da função. A página Detalhes da função é aberta em uma nova janela.
Na página Detalhes do monitor sintético, clique em
Excluir e conclua a caixa de diálogo.Agora você excluiu o monitor sintético.
Para excluir a função do Cloud Run, acesse a página Detalhes da função, clique em
Excluir e conclua a caixa de diálogo.- PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- CHECK_ID: 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 Encontrar o identificador exclusivo de um monitor sintético. - Clique em
projects.uptimeCheckConfigs.delete
. Use o APIs Explorer.
Defina o parent do método como o identificador do monitor sintético e use o seguinte formato:
projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID
Na expressão anterior:
- PROJECT_ID é o ID do projeto; Para configurações do App Hub, selecione o projeto host do App Hub ou o projeto de gerenciamento da pasta com app ativado.
- CHECK_ID é o ID do monitor sintético.
Para encontrar o valor de 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"
.
In the Google Cloud console, activate Cloud Shell.
At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.
REST
Para usar as amostras da API REST nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para a CLI gcloud.
After installing the Google Cloud CLI, initialize it by running the following command:
gcloud init
If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.
Para mais informações, consulte Autenticar para usar REST na documentação de autenticação do Google Cloud .
Listar monitores sintéticos
Console
Para listar os monitores sintéticos no seu projeto Google Cloud , faça o seguinte:
A página Monitores sintéticos mostra o seguinte para cada monitor sintético:
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 --project=PROJECT_ID
Antes de executar o comando anterior, substitua o seguinte:
Os dados retornados incluem o seguinte:
É possível configurar o comando da Google Cloud CLI para filtrar e classificar os resultados.
REST
Para listar os monitores sintéticos no seu projeto Google Cloud , incluindo verificações de tempo de atividade, chame o método
projects.uptimeCheckConfigs.list
:Para um monitor sintético, o resultado contém um campo chamado
syntheticMonitor
.Ver detalhes de um monitor sintético
Console
Para ver os detalhes de um monitor sintético no seu projeto Google Cloud , faça o seguinte:
gcloud
Para listar os detalhes de uma verificação de tempo de atividade ou um monitor sintético, execute o comando
gcloud monitoring uptime describe
:gcloud monitoring uptime describe CHECK_ID --project=PROJECT_ID
Antes de executar o comando anterior, substitua o seguinte:
Os dados retornados para a verificação de tempo de atividade incluem o seguinte:
REST
Para listar os detalhes de um monitor sintético específico no seu projeto Google Cloud , chame o método
projects.uptimeCheckConfigs.get
: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:
gcloud
Para modificar uma verificação de tempo de atividade ou um monitor sintético, execute o comando
gcloud monitoring uptime update
:gcloud monitoring uptime update CHECK_ID OPTIONAL_FLAGS --project=PROJECT_ID
Antes de executar o comando anterior, substitua o seguinte:
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 --project=PROJECT_ID
REST
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 editar um monitor sintético, chame o método
projects.uptimeCheckConfigs.patch
:Copiar um monitor sintético
Console
Para copiar um monitor sintético no seu projeto Google Cloud , faça o seguinte:
gcloud
Não há um método da Google Cloud CLI que permita copiar um monitor sintético.
REST
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:
Excluir um monitor sintético
Console
Para excluir um monitor sintético e as políticas de alerta associadas, faça o seguinte:
gcloud
Para excluir uma verificação de tempo de atividade ou um monitor sintético, execute o comando
gcloud monitoring uptime delete
:gcloud monitoring uptime delete CHECK_ID --project=PROJECT_ID
Antes de executar o comando anterior, substitua o seguinte:
REST
Para excluir um monitor sintético e as políticas de alertas associadas, chame o método
projects.uptimeCheckConfigs.delete
:Encontrar o identificador exclusivo de um monitor sintético
Quando o monitor sintético é criado, o Monitoring atribui um identificador a ele. Esse identificador está incorporado ao 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 dos métodos da Google Cloud CLI e da API Cloud Monitoring que criam ou listam monitores sintéticos.
A seguir
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-14 UTC.
-