Exportación y extracción de métricas de Prometheus

Las métricas recopiladas se recopilan de forma predeterminada y son totalmente compatibles con esta versión. Las métricas de OpenTelemetry son la base futura para la supervisión, disponibles a partir de GitHub Enterprise Server 3.18 en adelante.

Nota:

Se espera que las métricas recopiladas sean cerrar y, a continuación, retirado en una versión futura de GitHub Enterprise Server. Se recomienda que la estrategia de supervisión a largo plazo incluya una migración a métricas de OpenTelemetry. Consulta Acerca de las métricas de OpenTelemetry.

GitHub Enterprise Server incluye un exportador de métricas de Prometheus para simplificar la observación y la supervisión. Esta característica permite extraer las métricas directamente del dispositivo, lo que elimina la necesidad de reenviar las métricas de collectd a un servidor de collectd externo para su transformación antes de enviarlas a un sistema Prometheus. Al admitir métricas compatibles con Prometheus de forma nativa, el exportador permite una integración perfecta con paneles de supervisión externos y sistemas de alertas.

Habilitación del exportador de métricas de Prometheus y las métricas de extracción

De forma predeterminada, el exportador y la extracción de métricas de Prometheus están deshabilitados. Al habilitar el exportador para las métricas de collectd, se abre el punto de conexión de métricas (también se conoce como scrape endpoint) en http(s)://HOSTNAME:9103. Asegúrate de que las reglas de firewall permiten el tráfico en el puerto 9103.

Puedes habilitar el exportador de métricas de Prometheus mediante Consola de administración, la interfaz de línea de comandos dentro del dispositivo o la API.

Habilitar el uso de la Consola de administración

Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haz clic en .
Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.
En la barra lateral " Site admin", haz clic en Consola de administración.
En la configuración de supervisión, selecciona Habilitar prometheus.
En el campo direcciones IPv4/IPv6 de confianza o bloques CIDR de una lista separada por comas, escriba la lista separada por comas de direcciones IP o bloques CIDR. Un ejemplo: 10.0.0.1, 192.168.1.0/8. Si este campo se deja vacío, se aceptarán las solicitudes de extracción de cualquier dirección IP de origen.
En la barra lateral "Configuración" , haga clic en Guardar configuración.

Nota:

Al guardar la configuración en Consola de administración se restablecen los servicios del sistema, lo que podría generar un tiempo de inactividad visible para el usuario.
Espera que se complete la fase de configuración.

Habilitación a través de la interfaz de la línea de comandos

Para habilitar el exportador de métricas de Prometheus, usa SSH en el dispositivo GitHub Enterprise Server y ejecuta los siguientes comandos:

ghe-config app.prometheus.enabled true
# Specify a comma-separated list of 
# trusted IPv4/IPv6 addresses or CIDR blocks.
ghe-config app.prometheus.trusted-ips \
  "10.0.0.1, 192.168.1.0/8"
ghe-config-apply

Habilitación mediante la API

Puedes habilitar el exportador de métricas de Prometheus con la API mediante el envío de una solicitud de PUT para actualizar las opciones de configuración.

curl -L -H "Content-Type: application/json" \
  -X PUT -u "api_key:xxxxxxx" \
  https://<hostname>/manage/v1/config/settings \
  -d '{"prometheus": {"enabled": true, "trusted_ips": "10.0.0.1, 192.168.1.0/8"}}'

Comprobación de que el exportador de métricas de Prometheus está habilitado

Para comprobar que el exportador de métricas de Prometheus está habilitado, usa curl para consultar el punto de conexión de /metrics en el puerto 9103. Para obtener más información sobre los puertos administrativos, consulta Puertos de red.

curl 127.0.0.1:9103/metrics

Si se ejecuta correctamente, la respuesta incluirá métricas con el prefijo collectd_.

Configuración del servidor Prometheus externo

Para extraer métricas exportadas de GitHub Enterprise Server, agregue una configuración de extracción al archivo prometheus.yaml en el servidor externo Prometheus.

- job_name: "ghes-prom-agent"
  scrape_interval: 10s
  static_configs:
    - targets: ["http(s)://HOSTNAME:9103/metrics"]

Compatibilidad con el exportador de métricas de Prometheus de origen oscuro

Si has estado usando el exportador de métricas de Prometheus desde que se oscureció en GitHub Enterprise Server 3.12, seguirá funcionando después de actualizar a la versión 3.16. En esta versión, ahora tienes la opción de especificar direcciones IP de confianza para las solicitudes de extracción.

Puedes compartir tus comentarios sobre el exportador de métricas de Prometheus y la funcionalidad de extracción con GitHub. Para obtener ayuda con preguntas o problemas, ve a Soporte técnico para GitHub Enterprise.

En este artículo