Exportation et scraping des métriques Prometheus

GitHub Enterprise Server inclut un exportateur de métriques Prometheus pour simplifier l’observabilité et la surveillance. Cette fonctionnalité permet de scraper les métriques directement à partir de l’appliance, éliminant ainsi la nécessité de transmettre les métriques collectd à un serveur collectd externe pour les transformer avant de les envoyer à un système Prometheus. En prenant en charge les mesures compatibles avec Prometheus, l’exportateur permet une intégration transparente avec les tableaux de bord de surveillance et les systèmes d’alerte externes.

Activation de l’exportateur de métriques Prometheus et du scraping de métriques

Par défaut, l’exportateur de métriques Prometheus et le scraping sont désactivés. L’activation de l’exportateur pour les métriques collectd ouvre le point de terminaison des métriques (également connu sous le nom de scrape endpoint) à http(s)://HOSTNAME:9103. Assurez-vous que les règles de pare-feu autorisent le trafic sur le port 9103.

Vous pouvez activer l’exportateur de métriques Prometheus à l’aide de Management Console, de l’interface de ligne de commande de l’appliance ou de l’API.

Activation à l’aide de Management Console

1. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

2. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.

3. Dans la barre latérale «  Administrateur de site », cliquez sur Management Console .

4. Dans les paramètres de surveillance, sélectionnez Activer prometheus.

5. Dans le champ Adresses IPv4/IPv6 ou blocs CIDR de confiance dans une liste séparée par des virgules, tapez la liste d’adresses IP ou de blocs CIDR séparés par des virgules. Exemple : 10.0.0.1, 192.168.1.0/8. Si ce champ est laissé vide, les requêtes de scraping provenant de n’importe quelle adresse IP source seront acceptées.

6. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

   Note

   L’enregistrement des paramètres dans la Management Console redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.

7. Attendez la fin de l’exécution de la configuration.

Activation via l’interface de ligne de commande

Pour activer l’exportateur de métriques Prometheus, établissez une connexion SSH avec l’appliance GitHub Enterprise Server et exécutez les commandes suivantes :

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

Activation à l’aide de l’API

Vous pouvez activer l’exportateur de métriques Prometheus à l’aide de l’API en envoyant une requête PUT pour mettre à jour les paramètres de configuration.

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"}}'

Vérification de l’activation de l’exportateur de métriques Prometheus

Pour vérifier que l’exportateur de métriques Prometheus est activé, utilisez curl pour interroger le point de terminaison /metrics sur le port 9103. Pour plus d’informations sur les ports d’administration, consultez Ports réseau.

curl localhost:9103/metrics

En cas de réussite, la réponse inclura les métriques avec le préfixe collectd_.

Configuration de votre serveur Prometheus externe

Pour scraper les métriques exportées à partir de GitHub Enterprise Server, ajoutez une configuration de scraping au fichier prometheus.yaml sur votre serveur Prometheus externe.

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

Prise en charge de l’exportateur de métriques Prometheus (version darkship)

Si vous utilisez l’exportateur de métriques Prometheus depuis sa version darkship dans GitHub Enterprise Server 3.12, il continuera de fonctionner après la mise à niveau vers la version 3.16. Dans cette version, vous pouvez désormais spécifier des adresses IP de confiance pour les requêtes de scraping.

Partage de commentaires

Vous pouvez partager vos commentaires sur l’exportateur de métriques Prometheus et la fonctionnalité de scraping avec GitHub. Pour obtenir de l’aide sur des questions ou des problèmes, consultez Support GitHub Enterprise.