Como gerenciar canais de notificação

Esta página lista os tipos de canais de notificação compatíveis e explica como configurá-los usando o Console do Google Cloud: Para configurar canais de notificação usando a API Cloud Monitoring, consulte Como gerenciar canais de notificação.

Para informações sobre notificações de políticas de alertas, consulte as seguintes páginas:

  • Para obter informações sobre o atraso entre o início de um problema e a criação de um alerta, consulte Latência da notificação.
  • Para informações sobre o número de notificações geradas para uma política de alertas, consulte Notificações por incidente.

Como criar canais

Para configurar um canal de notificação, é preciso ter um dos papéis de gerenciamento de identidade e acesso a seguir no projeto host do espaço de trabalho:

  • Editor do canal de notificação do Monitoring
  • Editor do Monitoring
  • Administrador do Monitoring
  • Editor do projeto
  • Proprietário do projeto

Para mais informações sobre esses papéis, consulte Controle de acesso.

Ao criar uma política de alertas, você tem a opção de 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 Como criar um canal sob demanda.

Para criar um canal de notificação usando o Console do Cloud, faça o seguinte:

  1. No Console do Cloud, selecione Monitoring ou clique no botão a seguir:

    Acessar o Monitoramento

  2. Ao usar o painel de navegação do Monitoring, verifique se o espaço de trabalho correto está selecionado.

  3. No painel de navegação do Monitoring, clique em Alerta.

  4. Clique em Editar canais de notificação.

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

Email

Para adicionar um e-mail, acesse a seção E-mail, clique em Adicionar novo e siga as instruções.

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

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.

Uma política de alertas envia uma notificação por e-mail quando um incidente é criado e quando o incidente é resolvido. Esse comportamento não pode ser personalizado. No entanto, é possível configurar regras de e-mail para filtrar suas notificações por e-mail.

Aplicativo para dispositivos móveis

Use o aplicativo do Console do Cloud para dispositivos móveis para monitorar os recursos do Console do Cloud e as informações do Monitoring em qualquer lugar.

Para configurar seu dispositivo móvel para receber notificações do Monitoring, faça o seguinte:

  1. Instale o aplicativo do Console do Cloud para dispositivos móveis da loja de aplicativos do seu dispositivo móvel.
  2. No aplicativo do Console do Cloud para dispositivos móveis: selecione o menu Configurações para configurar o aplicativo para o espaço de trabalho. Você verá os recursos do Console do Cloud.
  3. Na seção Dispositivos móveis, clique em Adicionar novo e siga as instruções.

Depois de alguns minutos, seu dispositivo móvel será listado em Dispositivos móveis.

Ao criar uma política de alertas, selecione Console do Google Cloud (dispositivo móvel) na seção Notificações e escolha o dispositivo móvel na lista.

PagerDuty

A integração ao PagerDuty possibilita a sincronização unidirecional ou bidirecional com o Monitoring. Dependendo da configuração, os itens a seguir serão verdadeiros:

  • 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 a sincronização unidirecional estiver em uso e o incidente no PagerDuty for resolvido, o estado do incidente no PagerDuty será desacoplado do estado do incidente no Monitoring. Na verdade, se um incidente no PagerDuty for resolvido, o incidente será fechado permanentemente no PagerDuty e não poderá ser aberto novamente.

Se a sincronização bidirecional estiver em uso, o estado do incidente no PagerDuty será acionado pelo estado do incidente no Monitoring. Se o incidente no PagerDuty for resolvido e o Monitoring tiver o incidente aberto, o incidente será reaberto no PagerDuty.

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

  1. No PagerDuty: crie uma conta no site do PagerDuty.
  2. Para concluir a integração entre o PagerDuty e o Monitoring, siga as etapas descritas no Guia de integração do Stackdriver .
  3. Na janela Canais de notificação do Console do Google Cloud, adicione um canal de notificação do PagerDuty:
    1. Na seção PagerDuty, clique em Adicionar novo.
    2. Insira o Nome de exibição. Esse nome precisa corresponder ao nome fornecido ao PagerDuty quando a integração foi adicionada.
    3. Digite a chave do serviço de integração gerada pelo PagerDuty no campo Chave de serviço.
    4. Clique em Save.
  4. (Opcional) Para configurar a sincronização bidirecional, faça o seguinte:
    1. No PagerDuty, selecione Configuração, Serviços e o nome do serviço que você inseriu ao configurar a integração.
    2. Clique em Editar configurações e marque Criar incidentes. A ação desmarca Criar alertas e incidentes, que é a configuração padrão.

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

Neste documento, as capturas de tela do Stackdriver são de uma versão anterior do Stackdriver, mas as informações são precisas.

SMS

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

  1. Na seção SMS, clique em Adicionar novo e siga as instruções.
  2. Clique em Save.

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:

  1. No Slack: crie um canal no site do Slack. Grave o URL do canal.
  2. No Console do Cloud, selecione Monitoring:

    Acesse o Monitoring

  3. Clique em Alertas e em Editar canais de notificação.

  4. Na seção do Slack, clique em Adicionar novo. Isso leva você à página de login do Slack:

    1. Insira o URL do espaço de trabalho do Slack.
    2. Clique em Permitir para ativar o acesso do Google Cloud Monitoring ao seu espaço de trabalho do Slack.

    Quando você criar uma política de alertas, selecione Slack na seção Notifications e escolha a configuração do Slack.

Webhooks

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

  1. O gerenciador de webhooks: identifique o URL de um endpoint que receberá dados de webhook do Monitoring.
  2. Na seção Webhooks, clique em Adicionar novo e siga as instruções.
  3. Clique em Save.

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

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 querystring 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 parâmetro anexado. Esse método de autenticação é mais eficaz quando usado em conjunto 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.

Pub/Sub

Para enviar notificações a um tópico de Pub/Sub, faça o seguinte:

  1. Clique no botão a seguir para ativar a API Pub/Sub para seu projeto:

    Ativar a API Pub/Sub

    1. Verifique se o projeto correto do Google Cloud está selecionado.
    2. Se o botão Ativar for exibido, clique nele.
    3. Se a mensagem API ativada for exibida, quer dizer que a API já está ativada.
  2. Crie um tópico do Pub/Sub, como descrito em Como criar um tópico, se você ainda não tiver um. O tópico deve existir antes de ser usado como um canal de notificação. O comando a seguir cria um tópico chamado notificationTopic.

    gcloud pubsub topics create notificationTopic
  3. Crie um canal de notificação que use o tópico. Você pode usar a API Monitoring, a ferramenta de linha de comando gcloud ou o Console do Cloud.

    Para usar o Console do Cloud para criar o canal de notificação, acesse a janela Editar canais de notificação e faça o seguinte:

    1. Na seção Cloud Pub/Sub, clique em Adicionar novo.
    2. Insira um nome de exibição para o canal, insira o nome do tópico do Pub/Sub e clique em Adicionar canal.

    Para usar a API Monitoring ou a ferramenta de linha de comando gcloud para criar o canal de notificação, consulte Como criar canais para mais informações e exemplos.

  4. Autorize a publicação da conta do serviço de notificações em cada tópico do Pub/Sub que você está usando como canal de notificação.

    Quando você cria o primeiro canal Pub/Sub, o Cloud Monitoring cria uma conta de serviço para o Monitoring Notification Service Agent, para o projeto no qual o canal foi criado. Essa conta de serviço gerencia o envio de notificações para canais de notificação de Pub/Sub neste projeto.

    Essa conta de serviço tem um código com a seguinte estrutura:

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

    Você pode ver essa conta na página IAM, mas não na página Contas do Console do Cloud.

    Para autorizar a publicação dessa conta em um tópico, você precisa atribuir à conta de serviço o papel de pubsub.publisher do IAM para o tópico. O comando a seguir faz isso 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
    

    Se o comando for bem-sucedido, ele retornará a saída da seguinte forma:

    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 pubsub topics add-iam-policy-binding página de referência.

    O número do projeto não é o mesmo que o ID do projeto. IDs de projeto normalmente são strings que refletem o nome do projeto, como my-test-project. Os números do projeto são identificadores numéricos exclusivos. Você pode encontrar o nome, o ID e o número do projeto na página de destino do projeto no Console do Cloud ou recuperá-lo com o seguinte comando:

    gcloud projects describe [PROJECT_ID] --format="value(project_number)"
    
  5. Adicione o canal Pub/Sub a uma política de alertas selecionando Pub/Sub como o tipo de canal e um tópico nomeado como o canal de notificação.

Como 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. Se a lista não contiver um canal de notificação que você queira usar, será possível atualizar os canais de notificação configurados usando o seguinte processo:

  1. 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.
  2. 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.
  3. Retorne à guia original e, na caixa de diálogo de notificação, clique em Atualizar .

    Caixa de diálogo de notificação que exibe os botões de atualização e gerenciamento de canais.

  4. Selecione o canal de notificação na lista atualizada.

Como editar e excluir canais

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

  1. No Console do Cloud, selecione Monitoring ou clique no botão a seguir:

    Acessar Monitoring

  2. No painel de navegação do Monitoring, clique em Alerta.

  3. 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. Abaixo do cabeçalho da seção, há uma lista de 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.