Esta página foi traduzida pela API Cloud Translation.

Criar e gerenciar canais de notificação

Este documento descreve como configurar canais de notificação usando o console do Google Cloud. O Cloud Monitoring usa esses canais para notificar você ou sua equipe de plantão quando uma política de alertas é acionada. Ao criar uma política de alertas, você seleciona quem será notificado fazendo escolhas na lista de canais de notificação configurados. Por exemplo, é possível configurar políticas de alertas que monitoram instâncias do Compute Engine para publicar um tópico do Pub/Sub e notificar o canal do Slack da equipe de plantão.

Para mais informações, consulte Latência de notificação e Notificações por incidente.

Este documento descreve como usar o console do Google Cloud. Se você usa a API Cloud Monitoring, consulte Criar e gerenciar canais de notificação por API.

Antes de começar

Para receber as permissões necessárias para visualizar e configurar canais de notificação usando o console do Google Cloud, peça ao administrador para conceder a você o Papel do IAM de editor de monitoramento (roles/monitoring.editor) no seu 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 por meio de papéis personalizados ou de outros papéis predefinidos.

Para mais informações sobre os papéis do Cloud Monitoring, consulte Controlar o acesso com o Identity and Access Management.

Criar um canal de notificação

Ao criar uma política de alertas, você pode selecionar qualquer canal de notificação configurado e adicioná-lo à política. É possível pré-configurar os canais de notificação ou configurá-los como parte do processo de criação de uma política de alertas. Para mais informações, consulte Criar um canal sob demanda.

Para criar um canal de notificação usando o console do Google Cloud, siga as instruções específicas do canal contidas na tabela a seguir:

E-mail

Para adicionar um canal de notificação por e-mail, faça o seguinte:

No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Clique em Editar canais de notificação.
Na seção E-mail, clique em Adicionar novo.
Insira um endereço de e-mail e uma descrição.
Clique em Salvar.

Se um endereço de e-mail de grupo for utilizado como o canal de notificação de uma política de alertas, configure o grupo para aceitar e-mails de alerting-noreply@google.com.

Você pode criar canais de e-mail durante a criação de uma política de alertas. Para mais informações, consulte Criar um canal sob demanda.

Aplicativo para dispositivos móveis

Use o app para dispositivos móveis do Console do Google Cloud para monitorar os recursos do console do Google Cloud e as informações do Monitoring de qualquer lugar. As notificações do app para dispositivos móveis do console do Google Cloud são enviadas para um dispositivo ou usuário específico:

Lista de canais de notificação do app para dispositivos móveis do console do Google Cloud.

Dispositivo indica que as notificações são enviadas apenas para o dispositivo específico que criou o canal de notificação. Para canais de notificação com escopo no dispositivo, o campo Nome de exibição inclui informações do dispositivo.
Usuário indica que as notificações são enviadas para todos os seus dispositivos com o app do console do Google Cloud para dispositivos móveis instalado.

O Cloud Monitoring determina o escopo de notificação quando o canal é criado. Não é possível selecionar ou alterar o escopo.

Para configurar um canal de notificação do aplicativo para dispositivos móveis do console do Google Cloud para um projeto específico do Google Cloud, faça o seguinte:

Instale o app para dispositivos móveis do console do Google Cloud na loja de aplicativos do seu dispositivo móvel.
Selecione um projeto para visualização no aplicativo para dispositivos móveis do console do Google Cloud.

Depois de selecionar um projeto, ocorre uma troca de dados entre o aplicativo e o projeto do Google Cloud selecionado. Um canal de notificação é criado quando não existe e, após alguns minutos, esse canal é listado na seção Dispositivos móveis dos Canais de notificação.

Para adicionar seu dispositivo móvel como um canal de notificação para uma política de alertas, na seção Notificações, selecione Console do Google Cloud (dispositivo móvel) e escolha seu dispositivo móvel na lista.

PagerDuty

O PagerDuty oferece suporte à sincronização bidirecional com o Monitoring. Como resultado, as seguintes afirmações são verdadeiras:

Se um incidente for criado no Monitoring, um incidente será aberto no PagerDuty.
Não é possível usar o PagerDuty para encerrar um incidente no Monitoring.
Se você resolver um incidente no PagerDuty e o Monitoring tiver o incidente aberto, ele será reaberto no PagerDuty.

Para configurar as notificações do PagerDuty, faça o seguinte:

Na sua conta do PagerDuty, configure a integração em um novo serviço ou adicione a integração a um serviço existente.
1. Crie uma conta ou faça login em uma conta existente.
2. Acesse a página Serviços.
3. No painel Integrations do seu serviço, encontre a listagem da sua nova integração, abra o menu dela e copie a chave de integração.
4. Opcional: configure o PagerDuty para mapear com precisão os valores de gravidade de incidentes do Monitoring.
No Cloud Monitoring, adicione o canal de notificação do PagerDuty:
1. No console do Google Cloud, acesse a página Alertas:
  Acessar Alertas
  
  Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
2. Clique em Editar canais de notificação.
3. Na seção PagerDuty, clique em Adicionar novo.
4. Insira o Nome de exibição. Esse nome precisa corresponder ao nome do serviço do PagerDuty em que você configurou a nova integração na Etapa 1.
5. Cole a chave de integração que você copiou na Etapa 1 no campo Chave de serviço.
6. Clique em Salvar.

Ao criar uma política de alertas, selecione PagerDuty na seção Notifications e escolha a configuração do PagerDuty.

O pacote JSON para o PagerDuty tem o seguinte formato:

 {
     "description": A string of various fields in the incident,
     "details": JSON payload with schema version 1.2.
 }

Para conferir um exemplo e o esquema do campo details, abra as seções a seguir.

Exemplos JSON

Por padrão, o back-end de alertas tenta gerar um pacote JSON com a formatação da versão 1.2. Para mais informações sobre essa formatação, consulte a próxima seção.

Veja a seguir um exemplo desse pacote:


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

Estrutura do esquema, versão 1.2

Esta seção descreve a versão 1.2 do esquema de payload. Talvez alguns campos não apareçam em todos os pacotes retornados ou tenham valores vazios, dependendo da configuração da política de alertas, do estado do incidente ou do recurso que está sendo monitorado. Alguns campos aceitam estruturas incorporadas como valores; Essas estruturas são descritas por referência porque o conteúdo delas também pode variar.

Em um pacote retornado, os campos podem ocorrer em qualquer ordem. Na descrição a seguir, eles são organizados em grupos relacionados.

{
  "version": "1.2",
  "incident": {

    Informações sobre o incidente.

    "incident_id": string, ID gerado para este incidente.
    "scoping_project_id": string, o ID do projeto que hospeda o escopo de métricas.
    "scoping_project_number": número, o número do projeto de delimitação.
    "url": string, URL do console do Google Cloud para este incidente.
    "started_at": número e hora (em segundos de época do Unix) em que o incidente foi aberto.
    "ended_at": número, hora (em segundos de época do Unix) em que o incidente foi fechado. Preenchido apenas quando state for closed.
    "state": string, estado do incidente: open ou closed. Se open, ended_at será nulo.
    "summary": string, resumo textual gerado do incidente.
    "apigee_url": string, URL da Apigee para esse incidente, apenas para os tipos de recursos da Apigee Environment e Proxy*.
    "observed_value": string, valor observado que acionou/resolveu o alerta, pode estar vazio se a condição tiver expirado.

    Informações sobre o recurso monitorado para o qual o incidente foi aberto.

    "resource": {
      "type": sequência de caracteres, identificador do tipo de recurso monitorado que está sendo alertado, por exemplo, gce_instance. Consulte a Lista de recursos monitorados.
      "labels": objeto, pares de chave-valor para rótulos associados ao recurso monitorado.
    },
    "resource_type_display_name": string, nome de exibição do tipo de recurso monitorado.
    "resource_id": string, ID da instância do recurso monitorado, mesmo valor de resource.labels.instance_id.
    "resource_display_name": string, nome de exibição do recurso monitorado.
    "resource_name": string, nome gerado deste recurso monitorado. Consiste em valores de outros campos.

    Informações sobre o tipo de métrica dos dados de série temporal.

    "metric": {
      "type": string, identificador do tipo de métrica que está sendo alertado, por exemplo, compute.googleapis.com/instance/cpu/utilization. Consulte a Lista de métricas.
      "displayName": string, nome de exibição do tipo de métrica.
      "labels": objeto, pares de chave-valor para rótulos associados à métrica.
    },
    "metadata": {
      "system_labels": objeto, pares de chave-valor para rótulos de metadados do sistema.
      "user_labels": objeto, pares de chave-valor para rótulos de metadados do usuário.
    },

    Informações sobre a política de alertas e a condição que abriu/resolveu o incidente.
    Os valores são extraídos do objeto AlertPolicy relevante.

    "policy_name": string, nome de exibição da política de alertas.
    "policy_user_labels": objeto, pares de chave-valor para qualquer rótulo de usuário anexado à política.
    "documentation": objeto, uma estrutura incorporada do formulário Documentation.
    "condition": objeto, uma estrutura incorporada do formulário Condition.
    "condition_name": string, nome de exibição da condição, mesmo valor de condition.displayName.
    "severity": string, nível de gravidade dos incidentes. Se esse campo não for definido durante a criação da política de alertas, o Cloud Monitoring vai definir a gravidade da política de alertas como no severity.
    "threshold_value": a string, o valor de limite dessa condição, pode estar vazia se a condição não for de limite.
  },
}

Política de suspensão de uso

O esquema de payload está sujeito à política de descontinuação de uso de Google Cloud descrita na seção 1.4(d) dos Termos de Serviço do Google Cloud Platform. O esquema não controla os formatos dos valores de campo gerados, e esses formatos podem mudar sem aviso prévio. Por exemplo, incident.summary, incident.documentation.content e incident.url têm a finalidade de incluir dados relacionados aos campos, mas o esquema não tem restrições para garantir a análise precisa desses campos. É possível consumir o valor como um todo e esperar que ele siga a política de descontinuação, mas não depender da análise dos campos gerados.

Configurar o PagerDuty para mapear níveis de gravidade

Por padrão, as notificações do PagerDuty mostram todos os níveis de gravidade do incidente como "crítico". É possível configurar regras de orquestração de eventos no PagerDuty para que a gravidade do alerta do PagerDuty corresponda à gravidade do incidente do Monitoring:

Na sua conta do PagerDuty, acesse a página Serviços.
Selecione o serviço do PagerDuty em que você recebe notificações Google Cloud.
Clique em Configurações.
Acesse a seção Gerenciamento de eventos e clique em Acessar regras de orquestração.
Clique em Nova regra.
Para cada valor de gravidade de monitoramento que você quer converter, crie uma regra condicional que mapeie o valor de gravidade para um valor equivalente do PagerDuty:
1. No menu, em Etapa 1: quando essa regra deve ser aplicada?, Selecione Se os eventos corresponderem a determinadas condições.
2. Selecione o editor de código.
3. Na seção If, insira event.custom_details.incident.severity matches part 'VALUE', em que VALUE é o nome de um valor de gravidade de monitoramento e clique em Next.
4. Em Etapa 2: quais ações devem ser aplicadas, selecione Alert Data.
5. Defina a gravidade do alerta como um valor que corresponda ao valor de monitoramento que você inseriu na etapa C e salve as alterações.
Opcional: para adicionar outras regras, clique em Regra senão.

SMS

Para configurar notificações por SMS, faça o seguinte:

No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Clique em Editar canais de notificação.
Na seção SMS, clique em Adicionar novo.
Preencha a caixa de diálogo e clique em Salvar.

Ao configurar sua política de alertas, selecione o tipo de notificação SMS e escolha um número de telefone confirmado na lista.

Slack

Com a integração entre Monitoring e Slack, é possível publicar as políticas de alertas em um canal do Slack quando um novo incidente é criado. Para configurar as notificações do Slack, faça o seguinte:

No Slack: crie um espaço de trabalho e um canal no site do Slack. Grave o URL do canal.
No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Clique em Editar canais de notificação.
Na seção Slack, clique em Adicionar novo para abrir a página de login do Slack:
1. Selecione o espaço de trabalho do Slack.
2. Clique em Permitir para ativar o acesso do Cloud Monitoring ao seu espaço de trabalho do Slack. Essa ação levará você de volta à página de configuração do Monitoring do canal de notificação.
3. No campo Slack Channel Name, digite o nome do canal do Slack que você quer usar para as notificações.
4. No campo Nome de exibição do alerta do Cloud, insira uma breve declaração descritiva. O monitoramento mostra o valor desse campo na página Canal de notificações.
5. (Opcional) Para testar a conexão entre o Cloud Monitoring e seu espaço de trabalho do Slack, clique em Enviar notificação de teste. Se a conexão for bem-sucedida, você vai receber uma mensagem This is a test alert notification... no canal de notificação do Slack especificado. Verifique o canal de notificação para confirmar o recebimento.
Se o canal do Slack que você quer usar para notificações for um canal particular, convide o app Monitoring manualmente:
1. Abra o Slack.
2. Acesse o canal especificado como seu canal de notificação do Monitoring.
3. Convide o app do Monitoring para o canal inserindo e enviando a seguinte mensagem no canal:
```
/invite @Google Cloud Monitoring
```
  Convide o app do Monitoring para o canal privado que você especificou ao criar o canal de notificação no Monitoring. Convite o app Monitoring para canais públicos (opcional).
Quando você criar uma política de alertas, selecione Slack na seção Notifications e escolha a configuração do Slack.

Webhooks

Antes de configurar um canal de notificação de webhook, considere o seguinte:

Webhooks aceitam apenas endpoints públicos. Se você precisar enviar notificações para um endpoint que não é público, crie um canal de notificação do Pub/Sub e configure uma assinatura para o tópico do Pub/Sub. Para mais informações, consulte As notificações do webhook falham quando configuradas para um endpoint privado.
Se uma função do Cloud Run estiver configurada como endpoint de webhook para um canal de notificação, verifique se o usuário que invocou a função tem a permissão de autenticação necessária. Para mais informações, consulte Autenticar para invocação e Como ativar o acesso a uma função.
Os canais de notificação de webhook não são compatíveis com o Microsoft Teams. Para enviar dados de notificação do Monitoring para o Microsoft Teams, crie uma camada de integração para receber o webhook do Monitoring e redirecione-o para o Microsoft Teams.

Configurar canais de notificação de webhook

Para configurar as notificações de Webhooks, faça o seguinte:

O gerenciador de webhooks: identifique o URL do endpoint público para receber os dados do webhook do Monitoring.
No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Clique em Editar canais de notificação.
Na seção Webhook, clique em Adicionar novo.
Conclua a caixa de diálogo.
Clique em Test Connection para enviar um payload de teste ao endpoint do webhook. Você pode acessar o endpoint de recebimento para verificar a entrega.
Clique em Salvar.

Ao criar uma política de alertas, selecione Webhook na seção Notifications e escolha a configuração de webhook. As notificações enviadas pelo Error Reporting seguem o esquema 1.0, enquanto as notificações enviadas pelo Monitoring seguem o esquema 1.2:

Exemplos JSON

Por padrão, o back-end de alertas tenta gerar um pacote JSON com a formatação da versão 1.2. Para mais informações sobre essa formatação, consulte a próxima seção.

Veja a seguir um exemplo desse pacote:


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

Estrutura do esquema, versão 1.2

Em um pacote retornado, os campos podem ocorrer em qualquer ordem. Na descrição a seguir, eles são organizados em grupos relacionados.

{
  "version": "1.2",
  "incident": {

    Informações sobre o incidente.

    "incident_id": string, ID gerado para este incidente.
    "scoping_project_id": string, o ID do projeto que hospeda o escopo de métricas.
    "scoping_project_number": número, o número do projeto de delimitação.
    "url": string, URL do console do Google Cloud para este incidente.
    "started_at": número, hora (em segundos de época do Unix) em que o incidente foi aberto.
    "ended_at": número, hora (em segundos de época do Unix) em que o incidente foi fechado. Preenchido apenas quando state for closed.
    "state": string, estado do incidente: open ou closed. Se open, ended_at será nulo.
    "summary": string, resumo textual gerado do incidente.
    "apigee_url": string, URL da Apigee para esse incidente, apenas para os tipos de recursos da Apigee Environment e Proxy*.
    "observed_value": string, valor observado que acionou/resolveu o alerta, pode estar vazio se a condição tiver expirado.

    Informações sobre o recurso monitorado para o qual o incidente foi aberto.

    "resource": {
      "type": sequência de caracteres, identificador do tipo de recurso monitorado que está sendo alertado, por exemplo, gce_instance. Consulte a Lista de recursos monitorados.
      "labels": objeto, pares de chave-valor para rótulos associados ao recurso monitorado.
    },
    "resource_type_display_name": string, nome de exibição do tipo de recurso monitorado.
    "resource_id": string, ID da instância do recurso monitorado, mesmo valor de resource.labels.instance_id.
    "resource_display_name": string, nome de exibição do recurso monitorado.
    "resource_name": string, nome gerado deste recurso monitorado. Consiste em valores de outros campos.

    Informações sobre o tipo de métrica dos dados de série temporal.

    "metric": {
      "type": string, identificador do tipo de métrica que está sendo alertado, por exemplo, compute.googleapis.com/instance/cpu/utilization. Consulte a Lista de métricas.
      "displayName": string, nome de exibição do tipo de métrica.
      "labels": objeto, pares de chave-valor para rótulos associados à métrica.
    },
    "metadata": {
      "system_labels": objeto, pares de chave-valor para rótulos de metadados do sistema.
      "user_labels": objeto, pares de chave-valor para rótulos de metadados do usuário.
    },

    Informações sobre a política de alertas e a condição que abriu/resolveu o incidente.
    Os valores são extraídos do objeto AlertPolicy relevante.

    "policy_name": string, nome de exibição da política de alertas.
    "policy_user_labels": objeto, pares de chave-valor para qualquer rótulo de usuário anexado à política.
    "documentation": objeto, uma estrutura incorporada do formulário Documentation.
    "condition": objeto, uma estrutura incorporada do formulário Condition.
    "condition_name": string, nome de exibição da condição, mesmo valor de condition.displayName.
    "severity": string, nível de gravidade dos incidentes. Se esse campo não for definido durante a criação da política de alertas, o Cloud Monitoring vai definir a gravidade da política de alertas como no severity.
    "threshold_value": a string, o valor de limite dessa condição, pode estar vazia se a condição não for de limite.
  },
}

Autenticação básica

Além da solicitação de webhook enviada pelo Cloud Monitoring, a autenticação básica utiliza a especificação HTTP para o nome de usuário e a senha. O Cloud Monitoring exige que o servidor retorne uma resposta 401 com o cabeçalho WWW-Authenticate correto. Para mais informações sobre autenticação básica, consulte:

Autenticação de token

A autenticação de token exige um parâmetro de string de consulta no URL do endpoint e uma chave que o servidor espera que seja secreta entre ele e o Monitoring. Veja a seguir um URL de exemplo que inclui um token:

https://www.myserver.com/stackdriver-hook?auth_token=1234-abcd

Se o Monitoring postar um incidente no URL do endpoint, o servidor poderá validar o token anexado. Esse método de autenticação é mais eficaz quando usado com SSL/TLS para criptografar a solicitação HTTP que impede que espiões descubram o token.

Para um exemplo de servidor em Python, consulte este servidor de exemplo.

Política de suspensão de uso

Pub/Sub

Esta seção descreve como configurar os canais de notificação do Pub/Sub. Para fins de redundância, recomendamos que você crie vários canais de notificação. É recomendável parear o Pub/Sub com o Google Cloud Console Mobile App, PagerDuty, Webhooks ou Slack, porque o Pub/Sub usa um mecanismo de entrega diferente.

Para configurar um canal de notificação do Pub/Sub:

Ativar as APIs necessárias e criar um tópico
Configurar o canal de notificação para um tema
Autorizar uma conta de serviço
Definir o canal de notificação em uma política de alertas

Para entender o esquema de dados, consulte Exemplo de esquema.

Para receber as notificações de alerta, você também precisa criar uma das seguintes assinaturas: pull, push ou BigQuery.

Quando a assinatura estiver em um projeto diferente do tópico, crie uma conta de serviço no projeto do assinante e conceda a ela o papel de roles/pubsub.subscriber.

Antes de começar

Quando você adiciona o primeiro canal de notificação do Pub/Sub a um projeto do Google Cloud, o Cloud Monitoring cria uma conta de serviço para esse projeto. Ele também concede o papel do Identity and Access Management Agente de serviço de notificação do Monitoring à conta de serviço. Essa conta de serviço permite que o Monitoring envie notificações para canais de notificação baseados no Pub/Sub neste projeto.

A conta de serviço tem o seguinte formato:

service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

O nome da conta de serviço de notificações inclui um número exclusivo do projeto do Google Cloud. Você pode encontrar o nome, o ID e o número do projeto no painel do projeto no console do Google Cloud ou recuperá-lo com o seguinte comando:

gcloud projects describe PROJECT_ID --format="value(project_number)"

É possível visualizar e editar a conta de serviço usando o console do Google Cloud ou a CLI do Google Cloud.

Ativar as APIs necessárias e criar um tópico

No projeto do Google Cloud em que você planeja criar o canal de notificação e o tópico do Pub/Sub, faça o seguinte:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Pub/Sub and Cloud Monitoring APIs.

Enable the APIs

Crie um tópico do Pub/Sub. Para saber como criar um tópico, consulte Criar um tópico. Por exemplo, para criar um tópico chamado notificationTopic usando a Google Cloud CLI, execute o seguinte comando:
```
gcloud pubsub topics create notificationTopic
```

Em seguida, configure seus canais de notificação do Pub/Sub.

Configurar notificações para um tema

Para criar um canal de notificação do Pub/Sub, use a API Monitoring, a CLI do Google Cloud ou o console do Google Cloud. Depois de criar o canal de notificação, autorize a conta de serviço de notificações a publicar cada tópico que você está usando como canal de notificação.

Para informações sobre como usar a API Monitoring ou a Google Cloud CLI para criar o canal de notificação, consulte Como criar canais.

Para usar o console do Google Cloud para criar o canal de notificação, faça o seguinte:

No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Selecione o projeto do Google Cloud que contém o tópico do Pub/Sub que você criou.
Clique em Editar canais de notificação.
Na seção Pub/Sub, clique em Adicionar novo.

A caixa de diálogo Canal criado do Pub/Sub mostra o nome da conta de serviço que o Monitoring criou.
Autorize a conta de serviço. A conta de serviço pode publicar todos os tópicos ou tópicos específicos:
- Para publicar todos os tópicos, selecione Gerenciar papéis e adicione o papel de Editor do Pub/Sub.
  
  Depois de concluir essas etapas para configurar o canal de notificação, pule a próxima seção, que é intitulada Autorizar conta de serviço, e prossiga para Definir o canal de notificação em uma política de alertas.
- Para publicar tópicos específicos, avance para a próxima etapa e autorize a conta de serviço a publicar tópicos específicos depois de concluir a configuração do canal de notificação. Para instruções de autorização da conta de serviço, consulte Autorizar a conta de serviço.
Insira um nome de exibição para o canal e o nome do tópico do Pub/Sub.
(Opcional) Para verificar se o canal está configurado corretamente, clique em Enviar notificação de teste.
Selecione Adicionar canal.

Em seguida, autorize a conta de serviço.

Autorizar conta de serviço

A autorização permite que a conta de serviço de notificações publique cada tópico do Pub/Sub que você está usando como um canal de notificação. Esta seção descreve como fazer o seguinte:

Autorizar uma conta de serviço para um tópico específico.
Autorizar uma conta de serviço para todos os tópicos.

Autorizar uma conta de serviço para um tópico específico

É possível autorizar uma conta de serviço a publicar um tópico específico usando o console do Google Cloud e a CLI do Google Cloud. Esta seção descreve ambas as abordagens.

Para autorizar sua conta de serviço para um tópico específico usando o console do Google Cloud, faça o seguinte:

No console do Google Cloud, acesse a página Tópicos:
Acesse Tópicos

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Pub/Sub.
Selecione o tópico.
Na guia Permissões, selecione Adicionar participante.
No campo Novo principal, digite o nome da conta de serviço de notificações. A conta de serviço tem a seguinte convenção de nomenclatura:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Selecione o papel Editor do Pub/Sub e clique em Salvar.

Para autorizar sua conta de serviço para um tópico específico usando a CLI do Google Cloud, conceda o papel do IAM pubsub.publisher para o tópico à conta de serviço. Por exemplo, o comando a seguir configura o papel do IAM para o tópico notificationTopic:

gcloud pubsub topics add-iam-policy-binding \
projects/PROJECT_NUMBER/topics/notificationTopic --role=roles/pubsub.publisher \
--member=serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com

Uma resposta para uma execução bem-sucedida do comando add-iam-policy-binding é semelhante a esta:

 Updated IAM policy for topic [notificationTopic].
 bindings:
 ‐ members:
    ‐ serviceAccount:service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
    role: roles/pubsub.publisher
 etag: BwWcDOIw1Pc=
 version: 1

Para mais informações, consulte a página de referência pubsub topics add-iam-policy-binding.

Autorizar uma conta de serviço para todos os tópicos

Para autorizar a conta de serviço para todos os tópicos, faça o seguinte:

No console do Google Cloud, abra a página IAM.
Acesse o IAM

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo IAM e administrador.
Selecione Incluir concessões de papel fornecidas pelo Google, conforme mostrado na imagem a seguir:
Procure a conta de serviço com o seguinte formato:
```
service-PROJECT_NUMBER@gcp-sa-monitoring-notification.iam.gserviceaccount.com
```
Atualize a página quando a conta de serviço não estiver listada.
Selecione Editar na conta de serviço de notificações, selecione Adicionar outro papel e adicione o papel Editor do Pub/Sub.

Em seguida, defina o canal de notificação em uma política de alertas.

Definir o canal de notificação em uma política de alertas

Para usar um canal de notificação do Pub/Sub em uma política de alertas, selecione Pub/Sub como o tipo de canal e selecione o tópico.

Exemplo de esquema

Para conferir um exemplo de pacote JSON e o esquema, abra as seções a seguir.

Exemplos JSON

Por padrão, o back-end de alertas tenta gerar um pacote JSON com a formatação da versão 1.2. Para mais informações sobre essa formatação, consulte a próxima seção.

Veja a seguir um exemplo desse pacote:


{
  "incident": {
    "incident_id": "0.opqiw61fsv7p",
    "scoping_project_id": "internal-project",
    "scoping_project_number": 12345,
    "url": "https://console.cloud.google.com/monitoring/alerting/incidents/0.lxfiw61fsv7p?project=internal-project",
    "severity": "no severity",
    "started_at": 1577840461,
    "ended_at": 1577877071,
    "state": "closed",
    "resource_id": "11223344",
    "resource_name": "internal-project gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_display_name": "gke-cluster-1-default-pool-e2df4cbd-dgp3",
    "resource_type_display_name": "VM Instance",
    "resource": {
      "type": "gce_instance",
      "labels": {
        "instance_id": "11223344",
        "project_id": "internal-project",
        "zone": "us-central1-c"
      }
    },
    "metric": {
      "type": "compute.googleapis.com/instance/cpu/utilization",
      "displayName": "CPU utilization",
      "labels": {
        "instance_name": "the name of the VM instance"
      }
    },
    "metadata": {
      "system_labels": { "labelkey": "labelvalue" },
      "user_labels": { "labelkey": "labelvalue" }
    },
    "policy_name": "Monitor-Project-Cluster",
    "policy_user_labels" : {
        "user-label-1" : "important label",
        "user-label-2" : "another label"
    },
    "condition_name": "VM Instance - CPU utilization [MAX]",
    "threshold_value": "0.9",
    "observed_value": "0.835",
    "condition": {
      "name": "projects/internal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789",
      "displayName": "VM Instance - CPU utilization [MAX]",
      "conditionThreshold": {
        "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\" resource.type=\"gce_instance\" metadata.system_labels.\"state\"=\"ACTIVE\"",
        "aggregations": [
          {
            "alignmentPeriod": "120s",
            "perSeriesAligner": "ALIGN_MEAN"
          }
        ],
        "comparison": "COMPARISON_GT",
        "thresholdValue": 0.9,
        "duration": "0s",
        "trigger": {
          "count": 1
        }
      }
    },
    "documentation": {
      "content": "TEST ALERT\n\npolicy.name=projects/internal-project/alertPolicies/1234567890123456789\n\npolicy.display_name=Monitored-Project-NO-GROUPBY\n\ncondition.name=projects/nternal-project/alertPolicies/1234567890123456789/conditions/1234567890123456789\n\ncondition.display_name=VM Instance - CPU utilization [MAX]\n\nproject=internal-project\n\nresrouce.project=internal-project \n\nDONE\n",
      "mime_type": "text/markdown",
      "subject": "ALERT - No severity",
      "links": [
        {
          "displayName": "Playbook",
          "url": "https://myownpersonaldomain.com/playbook?name=${resource.name}"
        }
      ]
    },
    "summary": "CPU utilization for internal-project gke-cluster-1-16-default-pool-e2df4cbd-dgp3 with metric labels {instance_name=gke-cluster-1-default-pool-e2df4cbd-dgp3} and system labels {state=ACTIVE} returned to normal with a value of 0.835."
  },
  "version": "1.2"
}

Estrutura do esquema, versão 1.2

Em um pacote retornado, os campos podem ocorrer em qualquer ordem. Na descrição a seguir, eles são organizados em grupos relacionados.

Política de suspensão de uso

Google Chat

O app Google Cloud Monitoring permite que seus espaços do Google Chat recebam notificações.

Antes de começar

Se você estiver em uma organização, para instalar o Google Cloud Monitoring, é necessário ter acesso ao Google Cloud Monitoring. Se você não tiver acesso, peça para um administrador do Google Workspace fazer o seguinte:

Instalar o app Google Cloud Monitoring

Use o procedimento a seguir para instalar o appGoogle Cloud Monitoring. A instalação pela página do Google Workspace Marketplace não é compatível.

Para instalar o app e configurar um espaço como um canal de notificação, faça o seguinte:

No Google Chat, abra ou crie o espaço em que você quer receber notificações.
Instale o Google Cloud app Monitoring:
1. Selecione o nome do espaço e Apps e integrações.
2. Se o app Google Cloud Monitoring não aparecer na lista de apps, volte ao seu espaço, digite @Google Cloud Monitoring e pressione Enter.
3. Clique em Adicionar ao espaço.
Copie o ID do espaço de chat para a área de transferência.

Se você instalou o app Google Cloud Monitoring, o ID do espaço de chat será incluído na confirmação de instalação. Caso contrário, você pode encontrar o ID do espaço de chat como a série de números e letras após space/ no final do URL do espaço de chat.
Abra uma nova guia do navegador e configure o canal de notificação:
1. No console do Google Cloud, acesse a página Alertas:
  Acessar Alertas
  
  Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
2. Clique em Editar canais de notificação.
3. Acesse a seção Google Chat e clique em Adicionar novo.
4. Insira o ID do seu espaço de chat no campo ID do espaço de chat e clique em Salvar.

Criar um canal sob demanda

Ao adicionar um canal de notificação a uma política de alertas, é necessário selecionar um canal em uma lista. Para atualizar a lista de opções ao criar uma política de alertas, siga este processo:

Na caixa de diálogo de notificação, clique em Gerenciar canais de notificação. Você será direcionado para a janela Canais de notificação em uma nova guia do navegador.
Para adicionar um novo canal de notificação, localize o tipo de canal, clique em Adicionar novo e siga as instruções específicas do canal contidas na tabela anterior.
Retorne à guia original e, na caixa de diálogo de notificação, clique em Atualizar.
Selecione o canal de notificação na lista atualizada.

Receber notificações em um canal sem suporte

Se o canal de notificação preferido não tiver suporte, crie um pipeline que dependa do envio de notificações para o Pub/Sub. Para conferir um exemplo de Python que usa o Flask, consulte Como criar notificações personalizadas com o Cloud Monitoring e o Cloud Run. Para outros exemplos, consulte o repositório do Git cloud-alerting-notification-forwarding.

Testar um canal de notificação

O Cloud Monitoring não oferece uma opção de teste para canais de notificação. No entanto, é possível verificar se um canal de notificação está configurado corretamente criando uma política de alertas e configurando a condição a ser atendida.

Para testar manualmente os canais de notificação, crie uma política de alerta que monitore a utilização da CPU de uma das instâncias de máquina virtual (VM):

Opcional: se você ainda não tem uma VM no seu projeto do Google Cloud ou quer usar uma VM diferente para testes, crie uma VM:
1. No Console do Google Cloud, acesse a página Instâncias de VM.
  Acessar Instâncias de VM
  
  Se você usar a barra de pesquisa para encontrar a página, selecione o resultado com o subtítulo Compute Engine.
2. Selecione Criar instância e configure sua VM. Para mais informações sobre como criar VMs, consulte Criar uma instância de VM a partir de uma imagem pública.
No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Selecione Criar política.
Use o menu Selecionar uma métrica para selecionar a métrica Utilização da CPU para uma instância de VM.
Clique em Adicionar filtro e adicione um filtro à sua VM.
Atualize os campos Configurar acionador da seguinte maneira:
1. Selecione Abaixo do limite no campo Posição do limite.
2. Selecione um valor maior que a utilização da CPU para sua instância. Por exemplo, se o gráfico mostrar que a utilização da CPU é de cerca de 5%, defina o limite em 10%.
  
  Essas configurações configuram a condição a ser atendida quando a utilização da CPU de uma instância de VM for menor que o limite especificado. Como você selecionou o limite para ser maior que a utilização da CPU da sua instância de VM, a condição da política de alertas foi atendida.
Adicione os canais de notificação à sua política.
Expanda Duração do fechamento automático de incidentes e selecione 30 min.
Digite um nome e clique em Criar política.
Depois que a condição for atendida, verifique se você recebeu uma notificação em cada canal.
Exclua a política de alertas. O incidente é fechado automaticamente após o período de fechamento automático expirar.
Se você criou uma instância de VM para este teste, exclua-a.

Se você não estiver recebendo as notificações esperadas, pesquise no Explorador de registros entradas de registro com informações sobre as notificações ausentes. Para mais informações, consulte As notificações não são recebidas.

Editar e excluir canais de notificação

Para editar ou excluir um canal de notificação usando o console do Google Cloud, faça o seguinte:

No console do Google Cloud, acesse a página Alertas:
Acessar Alertas

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Monitoramento.
Clique em Editar canais de notificação.

O painel Canais de notificação contém uma seção para cada tipo de canal de notificação. Cada seção lista todas as configurações desse tipo:
- Para modificar uma entrada, clique em Editar. Clique em Salvar depois que suas alterações forem concluídas.
- Para excluir uma entrada, clique em Excluir. Clique em Excluir na caixa de diálogo de confirmação.

Acessar registros do canal de notificação

Use o Explorador de registros para conferir os erros do canal de notificação:

No console do Google Cloud, acesse a página Análise de registros:
Acessar a Análise de registros

Se você usar a barra de pesquisa para encontrar essa página, selecione o resultado com o subtítulo Logging.
Insira e execute a consulta. Para consultas específicas de erros do canal de notificação, consulte Consultas do Cloud Monitoring.

A seguir

Para informações sobre incidentes, consulte os seguintes documentos: