Configurar canais de notificação para alertas

O dispositivo do Google Distributed Cloud (GDC) com isolamento físico permite configurar canais de notificação personalizados para encaminhar alertas acionados a pessoas, equipes ou rotações de plantão específicas. O envio de alertas por canais como PagerDuty, SMS, webhooks ou integrações personalizadas ajuda a reduzir a fadiga de alertas e oferece suporte à resposta a incidentes em tempo hábil.

Como os canais de notificação predefinidos, como o Slack ou o e-mail, não estão disponíveis no GDC, é necessário configurar pelo menos um canal personalizado para receber alertas. Defina o tipo de canal, o endpoint de destino e as credenciais de autenticação em um objeto ConfigMap do Alertmanager. Em seguida, importe essa configuração para um recurso personalizado ObservabilityPipeline no namespace do projeto.

Antes de começar

Para gerenciar recursos personalizados do ObservabilityPipeline, é preciso ter as permissões necessárias.

Solicitar papéis do IAM da organização

Entre em contato com o administrador do IAM da organização para solicitar os seguintes papéis:

  • Criador de PA do ObservabilityPipeline (observabilitypipeline-pa-creator): cria recursos personalizados ObservabilityPipeline.
  • Editor de PA do ObservabilityPipeline (observabilitypipeline-pa-editor): editar ou excluir recursos personalizados ObservabilityPipeline.
  • Leitor de PA do ObservabilityPipeline (observabilitypipeline-pa-viewer): confira os recursos personalizados do ObservabilityPipeline.
  • Editor do ConfigMap (observabilitypipeline-configmap-editor): cria objetos ConfigMap no namespace da plataforma.

Solicitar papéis do IAM para o projeto

Entre em contato com o administrador do IAM do projeto para solicitar os seguintes papéis:

  • Editor do ObservabilityPipeline (observabilitypipeline-editor): editar ou excluir recursos personalizados ObservabilityPipeline no namespace do projeto.
  • Leitor do ObservabilityPipeline (observabilitypipeline-viewer): visualize recursos personalizados do ObservabilityPipeline no namespace do projeto.

Configurar canais de notificação

Configure canais de notificação para alertas no namespace do projeto:

  1. Defina a configuração personalizada para canais de notificação em um arquivo YAML chamado alertmanager.yml. Siga a mesma sintaxe da especificação do Alertmanager:

    https://prometheus.io/docs/alerting/latest/configuration/.

  2. Crie um objeto ConfigMap e inclua sua configuração personalizada do arquivo alertmanager.yml no campo data.

    O exemplo a seguir mostra como o objeto ConfigMap precisa ficar com o arquivo alertmanager.yml:

    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: CONFIGMAP_NAME
      # The namespace must match your project namespace.
      namespace: PROJECT_NAMESPACE
    data:
      # The file name must be alertmanager.yml
      alertmanager.yml: |
        # Define your notification channels.
        # Add the custom configuration in the following lines of this file.
        # Follow the same syntax as in https://prometheus.io/docs/alerting/latest/configuration
    
      [...]
    

    Substitua:

    • CONFIGMAP_NAME: o nome do arquivo de definição ConfigMap. Você vai usar esse nome mais tarde no recurso personalizado ObservabilityPipeline.
    • PROJECT_NAMESPACE: o namespace do projeto.
  3. Aplique o objeto ConfigMap ao servidor de API Management no mesmo namespace dos alertas configurados:

    kubectl --kubeconfig KUBECONFIG_PATH apply -f CONFIGMAP_NAME.yaml
    

    Substitua:

    • KUBECONFIG_PATH: o caminho para o arquivo kubeconfig do servidor de API Management.
    • CONFIGMAP_NAME: o nome do arquivo de definição ConfigMap.
  4. Edite a especificação do recurso personalizado ObservabilityPipeline para importar sua configuração para o campo alertmanagerConfig:

     # Configure the observability pipeline.
    apiVersion: observability.gdc.goog/v1
    kind: ObservabilityPipeline
    metadata:
      # The namespace must match your project namespace.
      namespace: PROJECT_NAMESPACE
      name: OBSERVABILITY_PIPELINE_NAME
    spec:
      # Configure alerts.
      alerting:
        # The alerting configuration must be in the ConfigMap.
        # The value must match the ConfigMap name exactly.
        alertmanagerConfig: CONFIGMAP_NAME
    
      [...]
    

    Substitua:

    • PROJECT_NAMESPACE: o namespace do projeto.
    • OBSERVABILITY_PIPELINE_NAME: o nome do recurso personalizado ObservabilityPipeline.
    • CONFIGMAP_NAME: o nome usado para o arquivo de definição ConfigMap. O nome precisa ser exatamente igual.
  5. Salve o arquivo.

  6. Aplique as mudanças do recurso personalizado ObservabilityPipeline ao servidor de API Management no mesmo namespace dos alertas configurados:

    kubectl --kubeconfig KUBECONFIG_PATH apply -f OBSERVABILITY_PIPELINE_NAME.yaml
    

    Substitua:

    • KUBECONFIG_PATH: o caminho para o arquivo kubeconfig do servidor de API Management.
    • OBSERVABILITY_PIPELINE_NAME: o nome do arquivo de definição de ObservabilityPipeline.