View a markdown version of this page

Conectando Grafana - AWS DevOps Agente
Requisitos de GrafanaRegistrar Grafana (a nivel de cuenta)Agregar Grafana a un espacio de agentesConfiguración de los webhooks de alertas de GrafanaLimitacionesAdministrar las conexiones de Grafana

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Conectando Grafana

La integración de Grafana permite al AWS DevOps agente consultar las métricas, los paneles y los datos de alertas de su instancia de Grafana durante las investigaciones de incidentes. Esta integración sigue un proceso de dos pasos: registrar Grafana a nivel de cuenta y, a continuación, conectarlo a Agent Spaces individuales.

Para mejorar la seguridad, la integración de Grafana solo habilita herramientas de solo lectura. Las herramientas de escritura están deshabilitadas y no se pueden habilitar. Esto significa que el agente puede consultar y leer los datos de su instancia de Grafana, pero no puede crear, modificar ni eliminar ningún recurso de Grafana, como paneles, alertas o anotaciones. Para obtener más información, consulta la sección Seguridad en el agente. AWS DevOps

Requisitos de Grafana

Antes de conectar Grafana, asegúrese de tener:

  • Grafana versión 9.0 o posterior. Es posible que algunas funciones, en particular las operaciones relacionadas con las fuentes de datos, no funcionen correctamente con las versiones anteriores debido a la falta de puntos finales de la API.

  • Una instancia de Grafana a la que se puede acceder a través de HTTPS. Se admiten puntos finales de redes públicas y privadas. Con la conectividad de red privada, su instancia de Grafana se puede alojar en una VPC sin acceso público a Internet. Para obtener más información, consulte Conexión a herramientas alojadas de forma privada.

  • Una cuenta de servicio de Grafana con un token de acceso que tenga los permisos de lectura adecuados

Registrar Grafana (a nivel de cuenta)

Grafana se registra a nivel de AWS cuenta y se comparte entre todos los espacios de agente de esa cuenta. Cada registro corresponde a una instancia de Grafana. Para registrar más instancias de Grafana, repita este proceso para cada una y asigne a cada registro su propio nombre de servicio.

Paso 1: configurar Grafana

  1. Inicie sesión en la consola de AWS administración

  2. Navegue hasta la consola del AWS DevOps agente

  3. Vaya a la página de proveedores de capacidades (a la que se puede acceder desde la barra de navegación lateral)

  4. Busque Grafana en la sección de proveedores disponibles, en Telemetría, y elija Registrarse

  5. En la página Configurar Grafana, introduzca la siguiente información:

    • Nombre del servicio (obligatorio): introduzca un nombre descriptivo para su servidor Grafana utilizando únicamente caracteres alfanuméricos, guiones y guiones bajos. Por ejemplo, my-grafana-server.

    • URL de Grafana (obligatorio): introduzca la URL HTTPS completa de su instancia de Grafana. Por ejemplo, https://myinstance.grafana.net.

    • Token de acceso a la cuenta de servicio (obligatorio): introduzca un token de acceso a la cuenta de servicio de Grafana. Los tokens suelen empezar glsa_ por. Para crear un token de cuenta de servicio, dirígete a tu instancia de Grafana, ve a Administración > Cuentas de servicio, crea una cuenta de servicio con la función de visor y genera un token.

    • Descripción (opcional): agrega una descripción para ayudar a identificar el propósito del servidor. Por ejemplo, Production Grafana server for monitoring.

  6. (Opcional) Agregue AWS etiquetas al registro con fines organizativos.

  7. Elija Siguiente.

Paso 2: Revise y envíe el registro de Grafana

  1. Revise todos los detalles de configuración de Grafana

  2. Elija Enviar para completar el registro

  3. Tras registrarse correctamente, Grafana aparecerá en la sección Registrados actualmente de la página de proveedores de capacidades

Agregar Grafana a un espacio de agentes

Después de registrar Grafana a nivel de cuenta, puede conectarlo a Agent Spaces individuales:

  1. En la consola de AWS DevOps agentes, seleccione su espacio de agente

  2. Vaya a la pestaña Capacidades

  3. En la sección Telemetría, elija Agregar

  4. Elija el registro de Grafana al que desea conectar a este espacio de agente.

  5. Seleccione Save.

Un solo Agent Space puede usar más de un registro de Grafana. Para conectar otro registro, repita estos pasos.

Configuración de los webhooks de alertas de Grafana

Puedes configurar Grafana para que active automáticamente las investigaciones de los AWS DevOps agentes cuando se activen alertas enviando webhooks a través de los puntos de contacto de Grafana. Para obtener más información sobre los métodos de autenticación de webhooks y la administración de credenciales, consulte. Invocar al DevOps agente a través de Webhook

Si pierdes el secreto del webhook, gíralo para generar un nuevo secreto. La URL del webhook no cambia. Para obtener instrucciones sobre cómo administrar las credenciales de los webhooks, consulta Administrar las credenciales de los webhooks.

Paso 1: Crea una plantilla de notificación personalizada

En tu instancia de Grafana, ve a Alertas > Puntos de contacto > Plantillas de notificaciones y crea una nueva plantilla con el siguiente contenido:

{{ 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 }}

Esta plantilla formatea las alertas de Grafana para adaptarlas a la estructura de carga útil de webhooks que espera el agente. AWS DevOps Mapea las etiquetas, las anotaciones y el estado de las alertas en los campos correspondientes e incluye todas las etiquetas de alerta como metadatos.

Paso 2: Crea un punto de contacto de webhook

  1. En Grafana, vaya a Alertas > Puntos de contacto y elija Agregar punto de contacto

  2. Selecciona Webhook como tipo de integración

  3. Configura la URL del punto final del webhook de tu AWS DevOps agente

  4. En la sección Configuración opcional de webhook, configura los encabezados de autenticación según el tipo de webhook. Consulta los métodos de autenticación de los webhooks para obtener más información.

  5. Configura el campo Carga útil personalizada para usar tu plantilla personalizada: {{ template "devops-agent-payload" . }}

  6. Elige Guardar punto de contacto

Paso 3: Asigne el punto de contacto a una política de notificación

  1. Diríjase a Alertas > Políticas de notificación

  2. Edita una política existente o crea una nueva

  3. Configura el punto de contacto en el punto de contacto del webhook que creaste

  4. Elige Guardar política

Cuando se active una alerta similar, Grafana enviará la carga útil formateada al AWS DevOps agente, que iniciará una investigación automáticamente.

Limitaciones

  • ClickHouse herramientas de fuente de datos: las herramientas ClickHouse de fuente de datos no son compatibles actualmente.

  • Prevención proactiva de incidentes: actualmente Prevención proactiva de incidentes no utiliza las herramientas de Grafana. El soporte está previsto para una versión futura.

Consideraciones sobre Amazon Managed Grafana

Si utiliza Amazon Managed Grafana (AMG), tenga en cuenta las siguientes limitaciones:

  • Los puntos de contacto de webhook no son compatibles: AMG no admite actualmente los puntos de contacto de webhook en su configuración de alertas. No puedes usar AMG para enviar webhooks de alertas directamente al agente. AWS DevOps Para obtener más información, consulte Cómo alertar a los puntos de contacto en Grafana gestionado por Amazon.

  • Caducidad de los tokens de las cuentas de servicio: los tokens de las cuentas de servicio de AMG tienen una caducidad máxima de 30 días. Deberás rotar los tokens y actualizar tu registro de Grafana en AWS DevOps Agent antes de que caduquen. Consulte Administrar las conexiones de Grafana para saber cómo actualizar las credenciales. Para obtener más información sobre los límites de los tokens AMG, consulte Cuentas de servicio en Amazon Managed Grafana.

Administrar las conexiones de Grafana

  • Actualización de las credenciales: si el token de tu cuenta de servicio caduca o necesitas actualizarlo, puedes cambiarlo sin anular el registro. En la página de proveedores de capacidades, selecciona tu registro en Grafana, elige Actualizar en el menú Acciones e ingresa el nuevo token. Sus asociaciones de Agent Space se conservan.

  • Visualización de las instancias conectadas: en la consola del AWS DevOps agente, seleccione su espacio de agente y vaya a la pestaña Capacidades para ver las fuentes de telemetría conectadas.

  • Eliminar Grafana: para desconectar Grafana de un espacio de agente, selecciónelo en la sección Telemetría y elija Eliminar. Para eliminar por completo el registro, elimínelo primero de todos los espacios de agente y, a continuación, anule el registro en la página de proveedores de capacidades.