Les mesures OpenTelemetry constituent la base future de la surveillance, qui seront disponibles à partir de GitHub Enterprise Server 3.18. Cette nouvelle pile de surveillance offre des capacités d'observabilité et de gestion supérieures à celles du système collectd hérité.
Les métriques collectées continuent d’être collectées par défaut et restent entièrement prises en charge dans cette version.
Prerequisites
- GitHub Enterprise Server 3.18 ou version ultérieure
- Accès administratif à la console de gestion Console de gestion
- Accès SSH à votre appliance GitHub Enterprise Server
Activation des métriques OpenTelemetry
Les métriques OpenTelemetry sont activées par défaut pour les nouvelles installations de GitHub Enterprise Server 3.19 et versions ultérieures. Les mises à niveau vers GitHub Enterprise Server 3.19 disposent toujours des métriques collectd activées par défaut, mais vous pouvez choisir de basculer vers les métriques OpenTelemetry.
Considérations relatives aux performances
Lors de la configuration des métriques OpenTelemetry, tenez compte des facteurs de performances suivants :
-
**Fréquence de collecte** : la collecte plus fréquente augmente la charge système -
**Conservation des données** : des périodes de rétention plus longues nécessitent davantage de stockage -
**Exportateurs personnalisés** : d’autres exportateurs peuvent augmenter l’utilisation du processeur et de la mémoire -
**Bande passante réseau** : la transmission des métriques externes affecte l’utilisation du réseau
Configuration de la collecte des métriques
Après avoir activé les métriques OpenTelemetry, vous pouvez personnaliser différents aspects du processus de collecte des métriques.
Définition des intervalles de collecte
L’intervalle de collecte des métriques par défaut est de 30 secondes. Vous pouvez ajuster cela en fonction de vos besoins de surveillance.
Important
La définition d’intervalles plus courts augmente la précision des métriques, mais augmente également la configuration requise pour le stockage et la charge système. Prenez en compte vos ressources système et vos exigences de surveillance avant d’ajuster ce paramètre.
Utilisation de la console de gestion Console de gestion pour définir des intervalles
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.
-
Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
-
Dans la barre latérale « Site admin », cliquez sur Console de gestion.
-
Dans les paramètres de surveillance, sous Intervalle de collecte des métriques, entrez l’intervalle souhaité en secondes (par exemple,
60). -
Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.
Remarque
L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.
-
Attendez la fin de l’exécution de la configuration.
Utilisation de la ligne de commande pour définir des intervalles
Connectez-vous via SSH à votre appliance GitHub Enterprise Server et exécutez les commandes suivantes :
# Set scrape interval to 60 seconds
ghe-config observability.metrics.interval 60
ghe-config-apply
Configuration de la rétention des données
Par défaut, les données de métriques sont conservées pendant 30 jours. Vous pouvez modifier ce paramètre à l’aide du Console de gestion ou de la ligne de commande.
Utilisation de la Console de gestion pour configurer la rétention
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.
-
Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
-
Dans la barre latérale « Site admin », cliquez sur Console de gestion.
-
Dans les paramètres de surveillance, sous Rétention des métriques, entrez la période de rétention souhaitée en jours (par exemple).
15 -
Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.
Remarque
L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.
-
Attendez la fin de l’exécution de la configuration.
Utilisation de la ligne de commande pour configurer la rétention
Connectez-vous via SSH à votre appliance GitHub Enterprise Server et exécutez les commandes suivantes :
# Set retention to 15 days
ghe-config observability.metrics.retention 15
ghe-config-apply
Configuration du niveau de verbosité pour la télémétrie interne
Le collecteur OpenTelemetry génère ses propres données de télémétrie internes pour surveiller l’intégrité et les performances du collecteur lui-même. Vous pouvez configurer le niveau de détail de cette télémétrie interne à l’aide de la ligne de commande.
Les niveaux de télémétrie disponibles sont les suivants :
*
none: désactive la télémétrie interne
*
basic: fournit des données de télémétrie essentielles (par défaut)
*
normal: fournit des données de télémétrie standard
*
detailed : fournit des données de télémétrie détaillées pour le débogage
Connectez-vous via SSH à votre appliance GitHub Enterprise Server et exécutez les commandes suivantes :
# Set internal telemetry level to normal
ghe-config observability.metrics.internal-otel-telemetry-level normal
ghe-config-apply
Remarque
Des niveaux de télémétrie plus élevés fournissent des informations plus détaillées sur les opérations internes du collecteur, mais augmentent également l’utilisation des ressources. Le basic niveau est recommandé pour les environnements de production, sauf si vous devez résoudre des problèmes liés au collecteur.
Dépannage des problèmes de configuration
Si vous rencontrez des problèmes avec la configuration d’OpenTelemetry, les informations suivantes peuvent vous aider à identifier et à résoudre les problèmes courants.
Problèmes de configuration courants
-
**Échecs de démarrage du service** : vérifiez les journaux système pour les messages d’erreur -
**Contraintes de ressources** : surveiller les ressources système lors de l’ajustement des intervalles de collecte
Affichage des journaux locaux
Connectez-vous au nœud que vous souhaitez déboguer et exécutez les commandes suivantes :
Afficher les logs du collecteur OpenTelemetry :
sudo journalctl -u otelcol-contrib -f
Afficher les journaux VictoriaMetrics :
sudo journalctl -u victoriametrics -f
Étapes suivantes
- Pour activer les tableaux de bord de supervision avancés, consultez Tableaux de bord avancés des métriques OpenTelemetry
- Exploration des métriques OpenTelemetry, voir Utilisation de Grafana pour analyser les métriques OpenTelemetry.
- Pour configurer la supervision externe, consultez Configuration de la supervision externe avec OpenTelemetry.