View a markdown version of this page

Conectando o Grafana - AWS DevOps Agente

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

Conectando o Grafana

A integração com o Grafana permite que o AWS DevOps Agente consulte métricas, painéis e dados de alerta de sua instância do Grafana durante investigações de incidentes. Essa integração segue um processo de duas etapas: registro do Grafana em nível de conta, seguido pela conexão com Espaços de Agentes individuais.

Para melhorar a segurança, a integração com o Grafana permite apenas ferramentas somente para leitura. As ferramentas de gravação estão desativadas e não podem ser ativadas. Isso significa que o agente pode consultar e ler dados da sua instância do Grafana, mas não pode criar, modificar ou excluir nenhum recurso do Grafana, como painéis, alertas ou anotações. Para obter mais informações, consulte Segurança no AWS DevOps Agente.

Requisitos do Grafana

Antes de conectar o Grafana, certifique-se de ter:

  • Grafana versão 9.0 ou posterior. Alguns recursos, especialmente operações relacionadas à fonte de dados, podem não funcionar corretamente com versões anteriores devido à falta de endpoints da API.

  • Uma instância do Grafana acessível por HTTPS. Há suporte para endpoints de rede pública e privada. Com a conectividade de rede privada, sua instância do Grafana pode ser hospedada em uma VPC sem acesso público à Internet. Para obter detalhes, consulte Conectando-se a ferramentas hospedadas de forma privada.

  • Uma conta de serviço Grafana com um token de acesso com permissões de leitura apropriadas

Registrando o Grafana (nível da conta)

O Grafana é registrado no nível da AWS conta e compartilhado entre todos os espaços do agente nessa conta. Cada registro corresponde a uma instância do Grafana. Para registrar instâncias adicionais do Grafana, repita esse processo para cada uma e dê a cada registro seu próprio nome de serviço.

Etapa 1: configurar o Grafana

  1. Faça login no AWS Management Console

  2. Navegue até o console do AWS DevOps agente

  3. Vá para a página Provedores de Capacidades (acessível pela navegação lateral)

  4. Encontre Grafana na seção Provedores disponíveis em Telemetria e escolha Registrar

  5. Na página Configurar Grafana, insira as seguintes informações:

    • Nome do serviço (obrigatório) — Insira um nome descritivo para o seu servidor Grafana usando apenas caracteres alfanuméricos, hífens e sublinhados. Por exemplo, .my-grafana-server

    • URL do Grafana (obrigatório) — Insira o URL HTTPS completo da sua instância do Grafana. Por exemplo, .https://myinstance.grafana.net

    • Token de acesso à conta de serviço (obrigatório) — Insira um token de acesso à conta de serviço Grafana. Os tokens normalmente começam comglsa_. Para criar um token de conta de serviço, navegue até sua instância do Grafana, acesse Administração > Contas de serviço, crie uma conta de serviço com a função Viewer e gere um token.

    • Descrição (opcional) — Adicione uma descrição para ajudar a identificar a finalidade do servidor. Por exemplo, .Production Grafana server for monitoring

  6. (Opcional) Adicione AWS tags ao registro para fins organizacionais.

  7. Escolha Próximo.

Etapa 2: revisar e enviar o registro do Grafana

  1. Revise todos os detalhes de configuração do Grafana

  2. Escolha Enviar para concluir o registro

  3. Após o registro bem-sucedido, o Grafana aparece na seção Registrado atualmente da página Provedores de Capacidades

Adicionando Grafana a um Agent Space

Depois de registrar o Grafana no nível da conta, você pode conectá-lo a espaços de agentes individuais:

  1. No console do AWS DevOps Agente, selecione seu Espaço do Agente

  2. Vá para a guia Capacidades

  3. Na seção Telemetria, escolha Adicionar

  4. Escolha o registro do Grafana que você deseja conectar a este Espaço do Agente.

  5. Escolha Salvar

Um único Agent Space pode usar mais de um registro do Grafana. Para conectar outro registro, repita essas etapas.

Configurando webhooks de alerta do Grafana

Você pode configurar o Grafana para acionar automaticamente as investigações do AWS DevOps agente quando os alertas forem disparados, enviando webhooks por meio dos pontos de contato do Grafana. Para obter detalhes sobre métodos de autenticação de webhook e gerenciamento de credenciais, consulte. Invocando o DevOps agente por meio do Webhook

Se você perder o segredo do webhook, gire o webhook para gerar um novo segredo. O URL do webhook não muda. Para obter instruções sobre como gerenciar credenciais de webhook, consulte Gerenciando credenciais de webhook.

Etapa 1: criar um modelo de notificação personalizado

Na sua instância do Grafana, navegue até Alertas > Pontos de contato > Modelos de notificação e crie um novo modelo com o seguinte conteúdo:

{{ define "devops-agent-payload" }} { "eventType": "incident", "incidentId": "{{ (index .Alerts 0).Labels.alertname }}-{{ (index .Alerts 0).Fingerprint }}", "action": "{{ if eq .Status "resolved" }}resolved{{ else }}created{{ end }}", "priority": "{{ if eq .Status "resolved" }}MEDIUM{{ else }}HIGH{{ end }}", "title": "{{ (index .Alerts 0).Labels.alertname }}", "description": "{{ (index .Alerts 0).Annotations.summary }}", "service": "{{ if (index .Alerts 0).Labels.job }}{{ (index .Alerts 0).Labels.job }}{{ else }}grafana{{ end }}", "timestamp": "{{ (index .Alerts 0).StartsAt }}", "data": { "metadata": { {{ range $k, $v := (index .Alerts 0).Labels }} "{{ $k }}": "{{ $v }}", {{ end }} "_source": "grafana" } } } {{ end }}

Este modelo formata os alertas do Grafana na estrutura de carga útil do webhook esperada pelo Agente. AWS DevOps Ele mapeia rótulos de alerta, anotações e status nos campos apropriados e inclui todos os rótulos de alerta como metadados.

Etapa 2: criar um ponto de contato de webhook

  1. No Grafana, navegue até Alertas > Pontos de contato e escolha Adicionar ponto de contato

  2. Selecione Webhook como o tipo de integração

  3. Defina o URL para o endpoint de webhook do seu AWS DevOps agente

  4. Em Configurações opcionais de webhook, defina os cabeçalhos de autenticação com base no seu tipo de webhook. Consulte Métodos de autenticação do Webhook para obter detalhes.

  5. Defina o campo Carga útil personalizada para usar seu modelo personalizado: {{ template "devops-agent-payload" . }}

  6. Escolha Salvar ponto de contato

Etapa 3: atribuir o ponto de contato a uma política de notificação

  1. Navegue até Alertas > Políticas de notificação

  2. Edite uma política existente ou crie uma nova

  3. Defina o ponto de contato para o ponto de contato do webhook que você criou

  4. Escolha Salvar política

Quando um alerta correspondente for acionado, o Grafana enviará a carga formatada ao AWS DevOps Agente, que iniciará uma investigação automaticamente.

Limitações

  • ClickHouse ferramentas de fonte de ClickHouse dados — as ferramentas de fonte de dados não são suportadas atualmente.

  • Prevenção proativa de incidentes — atualmente Prevenção proativa de incidentes não usa as ferramentas Grafana. O suporte está planejado para uma versão futura.

Considerações sobre o Amazon Managed Grafana

Se você estiver usando o Amazon Managed Grafana (AMG), esteja ciente das seguintes limitações:

  • Os pontos de contato de webhook não são suportados — atualmente, a AMG não oferece suporte a pontos de contato de webhook em sua configuração de alerta. Você não pode usar o AMG para enviar webhooks de alerta diretamente ao Agente. AWS DevOps Para obter detalhes, consulte Alertar pontos de contato no Amazon Managed Grafana.

  • Expiração do token da conta de serviço — Os tokens da conta de serviço AMG têm uma expiração máxima de 30 dias. Você precisará alternar os tokens e atualizar seu registro do Grafana no AWS DevOps Agente antes que eles expirem. Consulte Gerenciando conexões do Grafana para saber como atualizar as credenciais. Para obter detalhes sobre os limites do token AMG, consulte Contas de serviço no Amazon Managed Grafana.

Gerenciando conexões do Grafana

  • Atualização de credenciais — Se o token da sua conta de serviço expirar ou precisar ser atualizado, você poderá alterná-lo sem cancelar o registro. Na página Provedores de Capacidade, selecione seu registro no Grafana, escolha Atualizar no menu Ações e insira o novo token. Suas associações do Agent Space são preservadas.

  • Visualizando instâncias conectadas — No console do AWS DevOps Agente, selecione seu Espaço do Agente e vá até a guia Capacidades para visualizar as fontes de telemetria conectadas.

  • Removendo o Grafana — Para desconectar o Grafana de um Espaço do Agente, selecione-o na seção Telemetria e escolha Remover. Para remover completamente o registro, remova-o primeiro de todos os Espaços do Agente e depois cancele o registro na página Provedores de Capacidades.