Crie e faça a gestão de adiamentos

Este documento descreve como criar e gerir as suas pausas. Uma suspensão temporária impede que o Cloud Monitoring crie incidentes e emita notificações durante um período específico. Cada adiamento especifica os recursos aos quais se aplica.

Para uma vista geral conceptual, consulte Adie notificações e incidentes.

Para criar e gerir as suas suspensões temporárias, use a Google Cloud consola ou a API Cloud Monitoring.

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 a sua política de alertas:

  1. Certifique-se de que tem as autorizações necessárias:

    Para mais informações sobre as funções do Cloud Monitoring, consulte o artigo Controle o acesso com a gestão de identidade e acesso.

  2. Se quiser usar os exemplos da API Cloud Monitoring neste documento, faça o seguinte:

    1. Crie uma variável de ambiente, PROJECT_ID, para guardar o ID do seu Google Cloud projeto:

      PROJECT_ID=PROJECT_ID

    2. Autentique-se na CLI do Google Cloud:

      gcloud auth login

    3. Defina o Google Cloud projeto predefinido:

      gcloud config set project ${PROJECT_ID}

    4. Crie um token de autorização:

      ACCESS_TOKEN=`gcloud auth print-access-token`

      Tem de atualizar periodicamente o token de acesso. Se os comandos que funcionavam indicarem subitamente que não tem autenticação, reemita este comando.

Crie uma soneca

Para impedir que as políticas de alerta criem incidentes e enviem notificações, crie uma suspensão temporária. Quando restringe uma suspensão temporária a uma política de alerta, a suspensão temporária pode incluir filtros baseados em etiquetas. Se adicionar filtros baseados em etiquetas, a suspensão aplica-se apenas aos incidentes que correspondem aos filtros. Depois de criar uma suspensão temporária, não pode modificar o filtro baseado em etiquetas nem a lista de políticas às quais a suspensão temporária se aplica.

consola

A Google Cloud consola oferece duas formas de criar uma suspensão temporária:

  • Se começar na página Detalhes do incidente de um incidente aberto, a caixa de diálogo que preenche para criar a suspensão temporária está pré-configurada para apresentar a sua política de alertas. A caixa de diálogo também permite selecionar etiquetas, que são anexadas ao adiamento como filtros baseados em etiquetas.

  • Se começar na página Alertas, pode criar uma suspensão temporária cujos critérios listam até 16 políticas de alertas. No entanto, não pode anexar filtros baseados em etiquetas ao adiamento, mesmo quando os critérios de adiamento indicam uma política de alertas.

Para criar uma suspensão temporária a partir de um incidente aberto, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. No painel Incidentes da página Alertas, encontre o seu incidente e clique em Resumo do incidente.
  4. Na página Detalhes do incidente, clique em Adiar e, de seguida, selecione a duração do adiamento.

  5. Opcional: para adicionar um filtro baseado em etiquetas à suspensão temporária, aceda à secção Etiquetas e selecione uma ou mais etiquetas. Um filtro baseado em etiquetas pode incluir etiquetas de recursos e métricas. Quando a política de alerta não se baseia em PromQL, o filtro também pode incluir etiquetas de metadados.

    Normalmente, as suspensões temporárias aplicam-se a todos os incidentes criados por uma política de alertas. Os filtros permitem-lhe aplicar a suspensão temporária a incidentes cujas etiquetas correspondam às etiquetas no filtro.

  6. Clique em Suspender. A suspensão aplica-se agora à política de alertas que criou o incidente.

Para criar uma suspensão na página Alertas, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. Na página Alertas, clique em Criar suspensão.
  4. Introduza um nome descritivo para o adiamento. Este nome é apresentado na página Alertas.
  5. Selecione uma Hora de início. Pode introduzir uma hora específica ou iniciar a suspensão quando a suspensão é criada.
  6. Introduza a Duração. O valor deste campo determina a duração da suspensão temporária.

  7. Preencha a secção Critérios de adiamento. Pode usar o menu Políticas de alerta para selecionar as políticas de alerta às quais a suspensão se aplica.

    Pode adicionar até 16 políticas de alerta a uma suspensão.

    Depois de criar uma suspensão temporária, não é possível modificar os respetivos critérios.

    Depois de preencher a secção Critérios de adiamento, o painel Criar adiamento apresenta incidentes anteriores que correspondem aos critérios.

  8. Clique em Criar.

Cloud Monitoring API

A API Cloud Monitoring permite-lhe criar uma suspensão temporária cujos critérios listam até 16 políticas de alerta. Se a suspensão temporária se aplicar a uma política de alerta, também pode incluir filtros baseados em etiquetas.

Para criar uma suspensão temporária, invoque o método snoozes.create enviando um pedido POST para o ponto final Snooze. Tem de fornecer um objeto snooze:

curl -d @my-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X POST https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

Na expressão anterior, PROJECT_ID é uma variável de ambiente que armazena 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.

O método devolve um objeto snooze. O campo "name", que inclui o ID de adiamento gerado pela monitorização, é a única diferença entre o objeto devolvido e o conteúdo de my-snooze.json:

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/001122"
    ]
  },
  "interval": {
    "startTime": "2022-11-12T19:00:20Z",
    "endTime": "2022-11-12T19:05:20Z"
  },
  "displayName": "Snooze2"
}

CLI gcloud

A CLI gcloud permite-lhe criar uma suspensão temporária cujos critérios listam até 16 políticas de alerta. Se a suspensão temporária se aplicar a uma política de alerta, também pode incluir filtros baseados em etiquetas.

Para criar uma suspensão temporária, execute o comando gcloud monitoring snoozes create:

gcloud monitoring snoozes create --criteria-policies=LIST_OF_POLICIES --display-name=DISPLAY_NAME --start-time=START_TIME --end-time=END_TIME --project=PROJECT_ID --criteria-filter=FILTER

Antes de executar o comando anterior, substitua o seguinte:

  • LIST_OF_POLICIES: as políticas às quais o adiamento se aplica. Se especificar vários projetos, separe-os com uma vírgula.
  • 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.
  • DISPLAY_NAME: o nome a apresentar na consola Google Cloud .
  • START_TIME: a hora de início.

  • END_TIME : a hora de fim. O valor tem de ser, pelo menos, um minuto posterior à hora de início.

    Para as horas de início e de fim, tem de seguir as regras de formatação da norma ISO 8601. No entanto, pode especificar horas absolutas ou relativas. O exemplo seguinte especifica horas absolutas. Para adiar um alarme 30 minutos a partir da hora atual, use --start-time="+PTM30M".

  • FILTER: opcional. Pode definir um filtro baseado em etiquetas quando o adiamento se aplica a uma política de alerta. O filtro, que pode incluir etiquetas de recursos, métricas e metadados, aplica a suspensão temporária a incidentes com etiquetas correspondentes. Quando a política de alerta se baseia em PromQL, o filtro não pode usar etiquetas de metadados. Para mais informações, consulte a página de referência gcloud monitoring snoozes create.

Por exemplo, o comando seguinte cria uma suspensão temporária para uma política de alerta com um ID de "12345". O período de tempo do adiamento é o intervalo de 1 de março de 2025 a 7 de março de 2025.

gcloud monitoring snoozes create --display-name="Maintenance Week" \
    --criteria-policies="projects/my-project/alertPolicies/12345" \
    --start-time="2025-03-01T03:00:00.0-0500" \
    --end-time="2025-03-07T23:59:59.5-0500" \
    --project=PROJECT_ID

O exemplo anterior cria o seguinte adiamento em my-project:

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Maintenance Week"
}

Se for bem-sucedido, a resposta a este comando é semelhante à seguinte:

Created snooze [projects/my-project/snoozes/778899]

O nome de uma política de alerta não é apresentado na Google Cloud consola. Para determinar o nome de uma política de alerta, faça um dos seguintes:

  • Execute o comando gcloud alpha monitoring policies list. Os dados de resposta deste comando incluem o nome das suas políticas de alerta.
  • Veja a representação JSON de uma política de alertas. Pode transferir a representação JSON para o seu sistema local através de uma opção na página Detalhes da política.

Crie adiamentos recorrentes

Para criar adiamentos que ocorram em intervalos recorrentes, pode escrever um script que crie um adiamento para uma política de alertas. Em seguida, use um agendador de tarefas, como o cron ou o Cloud Scheduler, para executar o script na programação necessária.

Adie a lista

Quando cria uma repetição, esta é adicionada ao registo histórico de repetições do seu projeto. Este registo mostra os adiamentos expirados, ativos e futuros. Não pode remover entradas deste registo, ou seja, não pode eliminar uma repetição. No entanto, nesta vista, pode apresentar os detalhes sobre uma suspensão temporária e realizar ações como editar ou copiar a suspensão temporária.

consola

Para ver uma lista de adiamentos, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. Clique em Ver todas as suspensões no painel Suspender.

    A página Adiar apresenta uma lista de adiamentos e uma cronologia que apresenta graficamente os seus adiamentos anteriores, futuros e ativos.

    • Para editar, copiar, cancelar ou terminar uma repetição, use o menu Mais opções para a repetição. O estado de adiamento determina as opções disponíveis.
    • Para listar todos os adiamentos, ative a opção Mostrar adiamentos anteriores. Por predefinição, apenas são apresentados os adiamentos ativos e futuros.
    • Para alterar o período de apresentação da tabela Linha cronológica, use o menu Intervalo de tempo. Por predefinição, a tabela mostra dados para a hora seguinte. No entanto, pode modificar este campo para especificar intervalos de tempo passados ou futuros. As sestas expiradas são retidas durante 13 meses.
    • Para ver detalhes sobre um adiamento específico, clique em Ver detalhes.
    • Para ver um resumo das sestas ativas, posicione o ponteiro na área sombreada da linha Ativo na tabela Linha cronológica. A sugestão apresenta as informações de resumo.
    • Para ver uma representação gráfica dos adiamentos ativos, expanda a linha Ativo da tabela Linha cronológica.

Cloud Monitoring API

Para listar todas as repetições que pertencem a um Google Cloud projeto, invoque o método snoozes.list:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes

Na expressão anterior, PROJECT_ID é uma variável de ambiente que armazena 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.

O método devolve uma lista de objetos snooze. Por exemplo, quando um projeto tem um adiamento, a resposta ao comando snoozes.list é semelhante à seguinte:

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

Para obter informações sobre um adiamento específico, invoque o método snoozes.get e especifique o ID do projeto e o ID do adiamento. Na resposta anterior, o ID da suspensão temporária é 2986663705844383744:

curl -H "Authorization: Bearer $ACCESS_TOKEN" \
https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}

O método devolve um único objeto snooze:

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

CLI gcloud

Para listar as sestas no seu projeto atual, execute o comando gcloud monitoring snoozes list:

gcloud monitoring snoozes list --project=PROJECT_ID OPTIONAL_FLAGS

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.
  • OPTIONAL_FLAGS: para obter informações sobre as flags opcionais, consulte a página de referência gcloud monitoring snoozes list.

A resposta a este comando é uma lista de nomes de adiamentos no projeto, formatada como YAML. Por exemplo, a resposta a este comando para o Google Cloud projeto com o ID my-project é uma única entrada:

criteria:
  policies:
  - projects/my-project/alertPolicies/12345
  - projects/my-project/alertPolicies/23451
displayName: Maintenance Week
interval:
  endTime: '2023-03-08T04:59:59Z'
  startTime: '2023-03-01T08:00:00Z'
name: projects/my-project/snoozes/778899

Para listar detalhes sobre um adiamento específico, execute o comando gcloud monitoring snoozes describe:

gcloud monitoring snoozes describe NAME --project=PROJECT_ID

Por exemplo, para apresentar os detalhes sobre a função Adiar com o nome projects/my-project/snoozes/778899, execute o seguinte comando:

gcloud monitoring snoozes describe projects/my-project/snoozes/778899 --project=PROJECT_ID

Se fornecer um NAME inválido a um comando describe, a resposta contém um código de erro 500 e a seguinte mensagem:

Internal error encountered. Please retry after a few seconds. If internal errors persist, contact support at https://cloud.google.com/support/docs.

Edite uma repetição

Pode editar o nome e o período de um adiamento futuro, bem como o nome e a hora de fim de um adiamento ativo. Por exemplo, quando uma janela de manutenção é reagendada, pode ter de editar uma suspensão temporária.

Não pode editar um adiamento anterior, os critérios de um adiamento nem os filtros baseados em etiquetas anexados a um adiamento.

Se quiser agendar um adiamento anterior para um período futuro, copie o adiamento e aplique as alterações à cópia antes de selecionar Criar.

consola

Para editar uma suspensão temporária, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. Clique em Ver todas as suspensões no painel Suspender.
  4. Na lista de adiamentos, encontre o adiamento que quer editar e, de seguida, selecione Editar adiamento no menu Mais opções.
  5. Clique em Guardar depois de concluir as alterações.

Cloud Monitoring API

Para modificar uma suspensão temporária existente, invoque o método snoozes.patch enviando um pedido PATCH para o ponto final Snooze. Tem de fornecer o objeto snooze revisto e incluir parâmetros de consulta que identifiquem os campos modificados. Quando usar o curl, os parâmetros de consulta têm de ser codificados por URL.

Para adiamentos futuros, pode modificar o nome e o período. Para as pausas ativas, pode modificar o nome e a hora de fim. Não pode modificar as sestas anteriores.

Para atualizar o displayName de uma suspensão temporária, crie um ficheiro JSON, my-updated-snooze.json, que descreve o objeto de suspensão temporária e atualiza o nome a apresentar. Em seguida, execute o seguinte comando:

curl -d @my-updated-snooze.json -H "Authorization: Bearer $ACCESS_TOKEN" \
-H 'Content-Type: application/json' \
-X PATCH https://monitoring.googleapis.com/v3/projects/${PROJECT_ID}/snoozes/${SNOOZE_ID}?updateMask=displayName

Na expressão anterior:

  • PROJECT_ID é uma variável de ambiente que armazena 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.

  • SNOOZE_ID é uma variável de ambiente que armazena o ID da suspensão temporária.

O método devolve um objeto snooze idêntico ao conteúdo do ficheiro my-updated-snooze.json:

{
  "name": "projects/my-project/snoozes/778899",
  "criteria": {
    "policies": [
      "projects/my-project/alertPolicies/12345"
    ]
  },
  "interval": {
    "startTime": "2025-03-01T03:00:00.0-0500",
    "endTime": "2025-03-07T23:59:59.5-0500"
  },
  "displayName": "Snooze2"
}

CLI gcloud

Para editar uma suspensão temporária, execute o comando gcloud monitoring snoozes update. Pode atualizar o nome a apresentar, a hora de início e a hora de fim:

gcloud monitoring snoozes update NAME --project=PROJECT_ID OPTIONAL_FLAGS

Antes de executar o comando anterior, substitua o seguinte:

  • NAME: o nome da suspensão.
  • 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.
  • OPTIONAL_FLAGS: para obter informações sobre as flags opcionais, consulte a página de referência gcloud monitoring snoozes update.

Por exemplo, para alterar o nome a apresentar da função de adiar com o nome projects/my-project/snoozes/778899, execute o seguinte comando:

gcloud monitoring snoozes update projects/my-project/snoozes/778899 --display-name="Maintenance Week" --project=PROJECT_ID

Termine ou cancele uma suspensão

Se quiser receber notificações para recursos que correspondam aos critérios especificados numa suspensão ativa, termine a suspensão. Por exemplo, quando a manutenção planeada termina mais rapidamente do que o previsto, pode querer terminar uma suspensão temporária.

Se tiver um adiamento futuro que já não quer, cancele-o. A operação de cancelamento define a duração como zero e faz com que a suspensão temporária passe para o estado Anterior.

consola

Para terminar uma suspensão temporária ativa ou cancelar uma suspensão temporária futura, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. Clique em Ver todas as suspensões no painel Suspender.

  4. Na lista de adiamentos, encontre o adiamento que quer terminar ou cancelar e, em seguida, faça uma das seguintes ações:

    • Para terminar uma repetição ativa, selecione Terminar agora no menu Mais opções.
    • Para cancelar um adiamento futuro, selecione Cancelar adiamento no menu Mais opções.

Cloud Monitoring API

Para terminar uma suspensão ativa, edite a suspensão e defina a hora de fim para a hora atual. Para mais informações, consulte o artigo Edite um adiamento.

Para cancelar uma suspensão futura, edite a suspensão e defina a hora de fim para a hora de início da suspensão. A hora de início tem de ser uma hora futura. Para mais informações, consulte o artigo Edite um adiamento.

CLI gcloud

Para terminar uma repetição ativa ou cancelar uma repetição futura, execute o comando gcloud monitoring snoozes cancel:

gcloud monitoring snoozes cancel NAME --project=PROJECT_ID

Antes de executar o comando anterior, substitua o seguinte:

  • NAME: o nome da suspensão.
  • 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.

Por exemplo, para cancelar a repetição com o nome projects/my-project/snoozes/778899, execute o seguinte comando:

gcloud monitoring snoozes cancel projects/my-project/snoozes/778899 --project=PROJECT_ID

Copie uma suspensão

Quando quiser usar um adiamento existente como um modelo para outro adiamento, faça uma cópia. Quando copia um adiamento, o editor de adiamentos é aberto com todos os campos, exceto a hora de início, definidos para os valores no adiamento original. Pode modificar todos os campos antes de clicar em Criar.

Para copiar uma soneca através da consola, faça o seguinte:

  1. Na Google Cloud consola, aceda à página  Alertas:

    Aceder a Alertas

    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. Clique em Ver todas as suspensões no painel Suspender.
  4. Na lista de adiamentos, encontre o adiamento que quer editar e, de seguida, selecione Copiar adiamento no menu Mais opções.
  5. Aplique as modificações à cópia e, de seguida, clique em Criar.

O que se segue?