Faça a gestão de monitorizações sintéticas

Este documento descreve como gerir as suas monitorizações sintéticas. Pode ver uma lista dos seus monitorizadores sintéticos e, para cada monitorizador sintético, pode ver e modificar a configuração, ver o histórico de execução e ver detalhes sobre cada execução. Pode gerir os seus monitores sintéticos através da consola Google Cloud ou da API Cloud Monitoring.

Para ver informações sobre como explorar os resultados da execução e as métricas e os registos de um monitor sintético, consulte o artigo Explore os resultados do monitor sintético.

Esta funcionalidade só é suportada para projetos do Google Cloud . Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

Antes de começar

Conclua o seguinte no Google Cloud projeto que armazena o seu monitor sintético:

  • Para receber as autorizações de que precisa para ver e modificar monitores sintéticos através da Google Cloud consola, peça ao seu administrador para lhe conceder as seguintes funções do IAM no seu projeto:

    Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.

    Também pode conseguir as autorizações necessárias através de funções personalizadas ou outras funções predefinidas.

  • As instruções da API nesta página destinam-se ao Explorador de APIs. No entanto, também pode emitir um comando curl. O Explorador de APIs 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

    In the Google Cloud console, activate Cloud Shell.

    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 os exemplos da API REST nesta página num ambiente de desenvolvimento local, usa as credenciais que fornece à CLI gcloud.

      Instale a CLI Google Cloud. Após a instalação, inicialize a CLI gcloud executando o seguinte comando: 

      gcloud init

      Se estiver a usar um fornecedor de identidade (IdP) externo, primeiro tem de iniciar sessão na CLI gcloud com a sua identidade federada.

    Para mais informações, consulte o artigo Autenticar para usar REST na Google Cloud documentação de autenticação.

Liste os monitores sintéticos

Consola

Para listar os monitores sintéticos no seu Google Cloud projeto, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Monitorização sintética:

    Aceda à monitorização sintética

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

  3. Opcional: para restringir os monitores sintéticos apresentados, adicione filtros.

    Cada filtro é composto por um nome e um valor. Pode 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 são sensíveis a maiúsculas e minúsculas. Por exemplo, para listar todos os monitores sintéticos cujo nome contenha default, faça o seguinte:

    • Clique em Filtrar tabela e selecione Nome a apresentar.
    • Introduza default e, de seguida, prima a tecla Enter.

    Se tiver vários filtros, estes são automaticamente unidos por um operador lógico AND, a menos que insira um filtro OR. O exemplo anterior usa o filtro OR para que seja apresentada uma verificação de tempo de atividade se o respetivo nome corresponder a default ou Testing check.

A página Monitorizações sintéticas apresenta o seguinte para cada monitorização sintética:

  • Estado da execução mais recente.
  • Um link para informações detalhadas sobre esse monitor sintético.
  • A taxa de êxito e o tempo de execução médio.
  • O número de políticas de alerta.
  • Para editar, copiar ou eliminar 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 anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

Os dados devolvidos incluem o seguinte:

  • Nome e nome a apresentar.
  • Verifique o identificador.
  • Recurso monitorizado.
  • Período entre verificações.

Pode configurar o comando da CLI gcloud para filtrar e ordenar os resultados.

REST

Para listar os monitores sintéticos no seu Google Cloud projeto, incluindo verificações de tempo de atividade, chame o método projects.uptimeCheckConfigs.list:

  1. Clique em projects.uptimeCheckConfigs.list.

  2. Use o Explorador de APIs.

    Defina o parent do método para o nome do projeto e certifique-se de que usa o seguinte formato:

    projects/PROJECT_ID

    Na expressão anterior, PROJECT_ID é o ID do seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

Para um monitor sintético, o resultado contém um campo etiquetado como syntheticMonitor.

Veja os detalhes de um monitor sintético

Consola

Para ver os detalhes de um monitor sintético no seu Google Cloud projeto, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Monitorização sintética:

    Aceda à monitorização sintética

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

  3. Para abrir a página Detalhes do monitor sintético, localize o monitor sintético que quer ver e, de seguida, clique no respetivo nome.

    Se quiser ver a sua função do Cloud Run na página Detalhes da função fornecida pelas funções do Cloud Run, selecione o separador Código e, de seguida, clique no nome da função. A página Detalhes das funções é aberta numa nova janela. Os separadores nesta página permitem-lhe ver métricas e registos, bem como informações de configuração.

gcloud

Para listar os detalhes de uma verificação de tempo de atividade ou de uma monitorização sintética, 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 anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
  • CHECK_ID: o identificador da verificação de tempo de atividade ou da monitorização sintética. Pode encontrar o identificador executando o comando gcloud monitoring uptime list-configs e examinando o campo name. Para mais informações, consulte o artigo Encontre o identificador único de um monitor sintético.

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

  • Nome e nome a apresentar.
  • Verifique o identificador.
  • Recurso monitorizado.
  • Período entre verificações.

REST

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

  1. Clique em projects.uptimeCheckConfigs.get.

  2. Use o Explorador de APIs.

    Defina o parent do método para o identificador do monitor sintético, certifique-se de que usa o seguinte formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Na expressão anterior:

    • PROJECT_ID é o ID do seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
    • 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, pode emitir o método projects.uptimeCheckConfigs.list. Para reduzir o número de resultados devolvidos, inclua um filtro. Por exemplo, adicione o filtro displayName="MySyntheticMonitor".

Edite um monitor sintético ou uma função do Cloud Run

Consola

Para editar um monitor sintético ou a respetiva função do Cloud Run através da página Detalhes do monitor sintético, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Monitorização sintética:

    Aceda à monitorização sintética

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
  3. Localize o monitor sintético que quer editar, clique em Mais opções e, de seguida, selecione Editar.

  4. Opcional: para editar a função do Cloud Run, clique em Editar função, faça as alterações e, de seguida, clique em Aplicar função.

    Para verificadores de links danificados, para modificar o URI de origem ou as opções que definem os links testados, edite a função do Cloud Run e, em seguida, atualize o objeto options no ficheiro index.js. Para obter informações sobre os campos e a sintaxe deste objeto, consulte broken-links-ok/index.js.

  5. Para manter as modificações, clique em Guardar. 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 anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

  • CHECK_ID: o identificador da verificação de tempo de atividade ou do monitor sintético. Pode encontrar o identificador executando o comando gcloud monitoring uptime list-configs e examinando o campo name. Para mais informações, consulte o artigo Encontre o identificador exclusivo de uma verificação de tempo de atividade.

  • Defina os campos que quer modificar. Para monitores sintéticos, só pode atualizar os seguintes campos:

    • Período
    • Nome a apresentar
    • Tempo limite
    • Etiquetas do utilizador

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 as funções de alerta não estão contidas num monitor sintético e, por isso, não podem ser editadas através do procedimento descrito nesta secção:

Para editar um monitor sintético, chame o método projects.uptimeCheckConfigs.patch:

  1. Clique em projects.uptimeCheckConfigs.patch.

  2. Use o Explorador de APIs.

    1. Defina o parent do método para 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 seu projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
      • CHECK_ID é o ID do monitor sintético.

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

    2. Defina o parâmetro de consulta do método, updateMask, para identificar os campos no objeto que estão a ser modificados. Por exemplo, para atualizar o valor do parâmetro de consulta displayName, o parâmetro de consulta é o seguinte:

      updateMask=displayName

Copie um monitor sintético

Consola

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

  1. Na Google Cloud consola, aceda à página  Monitorização sintética:

    Aceda à monitorização sintética

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

  3. Localize o monitor sintético que quer editar, clique em Mais opções e, de seguida, 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.

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

  5. Para manter as modificações, clique em Criar. Caso contrário, clique em Cancelar.

    Quando clica em Criar, a função do Cloud Run é criada e implementada. Em seguida, o monitor sintético é criado.

gcloud

Não existe nenhum método da CLI do Google Cloud que lhe permita copiar um monitor sintético.

REST

Não existe um método de API que lhe permita copiar um monitor sintético. No entanto, pode fazer uma cópia através dos seguintes passos:

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

Elimine uma monitorização sintética

Consola

Para eliminar um monitor sintético e quaisquer políticas de alerta associadas, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Monitorização sintética:

    Aceda à monitorização sintética

    Se usar a barra de pesquisa para encontrar esta página, selecione o resultado cujo subtítulo é Monitorização.

  2. Na barra de ferramentas da Google Cloud consola, selecione o seu Google Cloud projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.

  3. Localize o monitor sintético que quer eliminar e, de seguida, clique no nome.

  4. Opcional: se quiser eliminar a função do Cloud Run, selecione o separador Código e, de seguida, clique no nome da função. A página Detalhes das funções é aberta numa nova janela.

  5. Na página Detalhes do monitor sintético, clique em Eliminar e, de seguida, conclua a caixa de diálogo.

    Acaba de eliminar o monitor sintético.

  6. Para eliminar a função do Cloud Run, aceda à página Detalhes das funções, clique em Eliminar e, de seguida, conclua a caixa de diálogo.

gcloud

Para eliminar 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 anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
  • CHECK_ID: o identificador da verificação de tempo de atividade ou da monitorização sintética. Pode encontrar o identificador executando o comando gcloud monitoring uptime list-configs e examinando o campo name. Para mais informações, consulte o artigo Encontre o identificador único de um monitor sintético.

REST

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

  1. Clique em projects.uptimeCheckConfigs.delete.

  2. Use o Explorador de APIs.

    Defina o parent do método para o identificador do monitor sintético, certifique-se de que usa o seguinte formato:

    projects/PROJECT_ID/uptimeCheckConfigs/CHECK_ID

    Na expressão anterior:

    • PROJECT_ID é o ID do seu projeto. Para configurações do App Hub, selecione o projeto anfitrião do App Hub ou o projeto de gestão da pasta com apps ativadas.
    • CHECK_ID é o ID do monitor sintético.

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

Encontre o identificador exclusivo de um monitor sintético

Quando o monitor sintético é criado, a Monitorização atribui-lhe um identificador. Este identificador está 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 dos métodos da API Cloud Monitoring que criam ou listam monitores sintéticos.

O que se segue?