Gerenciar monitores sintéticos

Este documento descreve como gerenciar seus monitores sintéticos. Você pode conferir uma lista dos seus monitores sintéticos e, para cada um deles, é possível acessar e modificar a configuração, conferir 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 os resultados de monitores sintéticos.

Esse recurso só está disponível para projetos Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

Antes de começar

Faça o seguinte no projeto do Google Cloud que armazena seu monitor sintético:

  • Para receber as permissões necessárias para visualizar e modificar monitores sintéticos usando o console do Google Cloud , peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

    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 usando papéis personalizados ou outros papéis predefinidos.

  • 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 API Explorer fornece a sintaxe curl.

  • Selecione a guia para como planeja usar as amostras nesta página:

    Console

    Quando você usa o console Google Cloud para acessar serviços Google Cloud e APIs, não é necessário configurar a autenticação.

    gcloud

    No console do Google Cloud , ative o Cloud Shell.

    Ativar o Cloud Shell

    Na parte de baixo do console Google Cloud , uma sessão do Cloud Shell é iniciada e exibe um prompt de linha de comando. O Cloud Shell é um ambiente shell com a CLI do Google Cloud já instalada e com valores já definidos para o projeto atual. A inicialização da sessão pode levar alguns segundos.

    REST

    Para usar as amostras da API REST nesta página em um ambiente de desenvolvimento local, use as credenciais fornecidas para CLI gcloud.

      Instale a CLI do Google Cloud.

      Ao usar um provedor de identidade (IdP) externo, primeiro faça login na CLI gcloud com sua identidade federada.

    Saiba mais em 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:

  1. No console Google Cloud , acesse a 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 Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  3. 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 Nome de exibição.
    • 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 filtro OR. O exemplo anterior usa o filtro OR para que uma verificação de tempo de atividade seja listada caso seu nome corresponda a default ou Testing 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 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 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 --project=PROJECT_ID

Antes de executar o comando anterior, substitua o seguinte:

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

Os dados retornados incluem o seguinte:

  • Nome e nome de exibição.
  • Verifique o identificador.
  • Recurso monitorado.
  • Período entre as verificações.

É 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:

  1. Clique em projects.uptimeCheckConfigs.list.

  2. 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 projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

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:

  1. No console Google Cloud , acesse a 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 Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  3. 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.

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:

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • 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.

Os dados retornados para a verificação de tempo de atividade incluem o seguinte:

  • Nome e nome de exibição.
  • Verifique o identificador.
  • Recurso monitorado.
  • Período entre as verificações.

REST

Para listar os detalhes de um monitor sintético específico no seu projeto Google Cloud , chame o método projects.uptimeCheckConfigs.get:

  1. Clique em projects.uptimeCheckConfigs.get.

  2. 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 ou de gerenciamento do App Hub.
    • 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, use o método projects.uptimeCheckConfigs.list. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtro displayName="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:

  1. No console Google Cloud , acesse a 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 Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  3. Localize o monitor sintético que você quer editar, clique em Mais opções e selecione Editar.

  4. 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 arquivo index.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, consulte broken-links-ok/index.js.

  5. 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, 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:

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  • 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

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:

  1. Clique em projects.uptimeCheckConfigs.patch.

  2. Use o APIs Explorer.

    1. 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 ou de gerenciamento do App Hub.
      • CHECK_ID é o ID do monitor sintético.

      Para encontrar o valor de CHECK_ID, use o método projects.uptimeCheckConfigs.list. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtro displayName="MySyntheticMonitor".

    2. 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

Copiar um monitor sintético

Console

Para copiar um monitor sintético no seu projeto Google Cloud , faça o seguinte:

  1. No console Google Cloud , acesse a 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 Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  3. Localize o monitor sintético que você quer editar, clique em 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.

  4. Clique em Criar função, atualize a função conforme necessário e clique em Aplicar função.

  5. 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 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:

  1. Chame o método projects.uptimeCheckConfigs.get e salve a resposta. Para mais informações, consulte Ver detalhes de um monitor sintético.
  2. Edite a resposta.
  3. Chame o método projects.uptimeCheckConfigs.create e transmita a resposta editada.

Excluir um monitor sintético

Console

Para excluir um monitor sintético e todas as políticas de alertas associadas, faça o seguinte:

  1. No console Google Cloud , acesse a 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 Monitoring.

  2. Na barra de ferramentas do console Google Cloud , selecione seu projeto Google Cloud . Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.

  3. Localize o monitor sintético que você quer excluir e clique no nome dele.

  4. 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.

  5. 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.

  6. 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.

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:

  • PROJECT_ID: o identificador do projeto. Para configurações do App Hub, selecione o projeto host ou de gerenciamento do App Hub.
  • 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.

REST

Para excluir um monitor sintético e as políticas de alertas associadas, chame o método projects.uptimeCheckConfigs.delete:

  1. Clique em projects.uptimeCheckConfigs.delete.

  2. 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 ou de gerenciamento do App Hub.
    • CHECK_ID é o ID do monitor sintético.

    Para encontrar o valor de CHECK_ID, use o método projects.uptimeCheckConfigs.list. Para reduzir o número de resultados retornados, inclua um filtro. Por exemplo, adicione o filtro displayName="MySyntheticMonitor".

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