Configurar e gerenciar notificações

É possível configurar o Error Reporting para enviar notificações de erro aos canais de notificação selecionados do Cloud Monitoring.

O Error Reporting envia notificações nos seguintes casos:

• Quando ocorre um erro em um projeto do Google Cloud pela primeira vez e não é possível agrupá-lo com erros anteriores.

• Se um erro marcado como Resolvido ocorrer novamente.

Gerenciar canais de notificação

Crie, edite e exclua canais de notificação no Monitoring. Depois de criar canais de notificação, é possível configurar o Error Reporting para usá-los.

O Error Reporting permite que você selecione um dos quatro tipos de canais de notificação: e-mail, dispositivos móveis, Slack e webhooks.

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 do Monitoring (roles/monitoring.editor) no projeto. Para mais informações sobre como conceder papéis, consulte Gerenciar acesso.

Também é possível conseguir as permissões necessárias por meio de papéis personalizados ou 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 canal de notificação

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:

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

   Acessar o alerta

2. Clique em Editar canais de notificação.
3. Na seção E-mail, clique em Adicionar novo.
4. Insira um único endereço de e-mail e uma descrição.
5. Clique em Save.

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 [e-mail].

Aplicativo para dispositivos móveis

Use o aplicativo 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:

• 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.
• User indica que as notificações são enviadas a todos os dispositivos em que o app Google Cloud Console está 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:

1. Instale o app para dispositivos móveis do console do Google Cloud na app store do seu dispositivo móvel.

2. Selecione um projeto para visualização no app 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 Notifications de alertas, selecione Google Cloud Console (mobile) e escolha seu dispositivo móvel na lista.

Slack

Observação: para concluir estas etapas, você precisa ser proprietário ou administrador do Slack Workspace. Para mais informações, consulte Como gerenciar solicitações de convite.

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

1. No Slack: crie um espaço de trabalho e um canal no site do Slack. Grave o URL do canal.

2. No Console do Google Cloud, selecione Monitoring e clique em  Alertas ou clique no botão a seguir:

   Acessar o alerta

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

4. 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, insira o nome do canal do Slack que você quer usar para notificações.
   4. No campo Nome de exibição do Cloud Alerting, insira uma breve descrição. O Monitoring exibe o valor desse campo na página Canal de notificações.
   5. (Opcional) Para testar a conexão entre o Cloud Monitoring e o espaço de trabalho do Slack, clique em Send test notification. Se a conexão for bem-sucedida, você verá 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.

5. Se o canal do Slack que você quer usar para notificações for particular, será necessário convidar manualmente o aplicativo do Monitoring para o canal:

   1. Abra o Slack.

   2. Acesse o canal especificado como seu canal de notificação do Monitoring.

   3. Convide o app Monitoring para o canal. Para isso, digite e envie a seguinte mensagem no canal:

      /invite @Google Cloud Monitoring

      Certifique-se de convidar o aplicativo do Monitoring para o canal particular especificado ao criar o canal de notificação no Monitoring. Convidar o aplicativo do Monitoring para canais públicos é opcional.

Webhooks

Observação: os webhooks são compatíveis apenas com endpoints públicos.

Observação: se uma Função do Cloud estiver configurada como endpoint de webhook para um canal de notificação, verifique se o usuário que invoca a função tem a permissão de autenticação necessária. Para mais informações, consulte Como autenticar a função para chamadas de função e Como ativar o acesso a uma função.

Cuidado: para receber notificações com o Google Chat, implante um serviço do Cloud Run e envie suas notificações para o Pub/Sub. Para ver um exemplo dessa configuração, consulte Como criar notificações personalizadas com o Cloud Monitoring e o Cloud Run.

Não configure uma notificação do webhook e configure o Google Chat para usar esse webhook.

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

1. O gerenciador de webhooks: identifique o URL do endpoint público para receber os dados do webhook do Monitoring.

2. No Console do Google Cloud, selecione Monitoring e clique em  Alertas ou clique no botão a seguir:

   Acessar o alerta

3. Clique em Editar canais de notificação.
4. Na seção Webhook, clique em Add new.
5. Preencha a caixa de diálogo.
6. Clique em Testar conexão para enviar um payload de teste ao endpoint do webhook. Acesse o endpoint de recebimento para verificar a entrega.
7. Clique em Save.

Esquema do webhook

Para visualizar a estrutura de esquema do webhook para o Error Reporting, clique em:

Estrutura do esquema, versão 1.0

{
  "version": "1.0",
  "subject": string, descrição do grupo de erros novo ou reaberto.
  "group_info": {
    "project_id": string, projeto que é proprietário do grupo de erros.
    "detail_link": string, link para a página Detalhes do Error Reporting do grupo de erros.
  },
  "exception_info": {
    "type": string, tipo da exceção registrada no evento.
    "message": string, mensagem de exceção do evento.
  },
  "event_info": {
    "log_message": string
    "request_method": string
    "request_url": string
    "referrer": string
    "user_agent": string
    "service": string
    "version": string
    "response_status": string
  },
}

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:

• Especificação RFC
• Autenticação básica

Autenticação de token

A autenticação por token requer 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, impedindo que snoopers aprendam o token.

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

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:

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

   Acessar o alerta

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

Observação: não é possível excluir um canal de notificação usando o console do Google Cloud quando o canal está associado a uma política de alertas. No entanto, é possível excluir o canal usando a Google Cloud CLI ou a API Cloud Monitoring. Para mais informações, consulte Criar e gerenciar canais de notificação por API.

Selecionar canais de notificação no console do Google Cloud

Para selecionar um canal de notificação existente, é necessário ter um dos seguintes papéis:

• Usuário do Error Reporting
• Administrador do Error Reporting
• Editor do projeto
• Proprietário do projeto

Para selecionar para onde você quer enviar notificações quando novos grupos de erros ocorrerem, siga as etapas a seguir.

1. No Console do Google Cloud, selecione Error Reporting ou clique no botão a seguir e selecione um projeto:

   Acessar o Error Reporting

2. Clique em Configurar notificações para abrir a página Notificações de erro.

3. No menu suspenso Canais de notificação, selecione os canais para os quais você quer enviar as notificações.

   Se você não encontrar o canal necessário, clique em Gerenciar canais de notificação para criar um novo canal. Para criar um canal de notificação, seu papel precisa ser aquele listado em Como criar canais.

4. Depois de selecionar os canais, clique em Salvar.

Mais informações

Veja a seguir informações adicionais que se aplicam ao criar e gerenciar notificações no Error Reporting.

Quando as notificações são enviadas?

O Error Reporting envia uma notificação em dois cenários:

• Quando o grupo de erros nunca foi visto pelo Error Reporting.
• Quando ocorre um erro para um grupo de erros existente e o status do grupo de erros é definido como Resolved.

Para receber notificações futuras do grupo de erros, defina o status do grupo de erros como Resolved. Nenhuma outra ação, como usar a API para excluir o grupo de erros ou aguardar que os dados expirem, resultará em uma notificação se ocorrer outro erro.

Limite da taxa de notificação

Para limitar o número de notificações que você pode receber devido a erros, o Error Reporting usa as seguintes regras:

• Notificar até cinco vezes por hora por projeto do Google Cloud. As notificações podem ser de diferentes grupos de erros.

• Se o número máximo de notificações por hora for atingido e outro erro ocorrer, envie mais uma notificação indicando que todas as notificações estão suspensas por seis horas.

Status da resolução

Se um erro com status de resolução Resolvido ocorrer novamente, mesmo que tenha sido excluído anteriormente, o status de resolução será revertido para Aberto e o Error Reporting enviará uma notificação.

O Error Reporting não enviará uma notificação se um erro Item silenciado ocorrer outra vez.

Para gerenciar o status de resolução dos seus erros, acesse Gerenciar erros.

Notificações no dispositivo móvel

O Error Reporting envia notificações para dispositivos móveis ao aplicativo do Google Cloud no Android e no iOS. Para ativar as notificações para dispositivos móveis, é preciso instalar o app no seu dispositivo móvel primeiro:

Faça o download do app Google Cloud