À propos des offres groupées de support pour GitHub Enterprise Server

À propos des offres groupées de support

Un bundle de support est une archive compressée des données de diagnostic de votre GitHub Enterprise Server instance. Vous pouvez utiliser des lots de support pour travailler avec Support GitHub sur des problèmes et générer des rapports de vérification de l’état qui résument la configuration, l’état et l’activité de votre instance.

Quand générer un bundle de support

Générez un bundle de support dans plusieurs scénarios :

Analyse des tickets de support

Support GitHub peut demander un bundle de support lors de l’examen des problèmes de performances, des échecs de service, des problèmes d’authentification ou d’autres problèmes opérationnels. Ouvrez d’abord un ticket de support, puis générez l’offre groupée et incluez votre numéro de ticket pour l’associer à votre cas. Pour plus d’informations, consultez Utilitaires de ligne de commande.

Analyse de l'état de santé

Vous pouvez générer un bundle de support pour créer un rapport Health Check. Les contrôles d’intégrité analysent vos données de bundle de support et signalent l’intégrité, la sécurité, les opérations Git et l’utilisation de l’API de votre instance. Pour plus d’informations, consultez « Générer un bilan de santé pour votre entreprise ».

Contenu d’un bundle de support

Les offres groupées de support contiennent plusieurs catégories de données de votre instance. Le contenu exact dépend de votre version et de votre GitHub Enterprise Server configuration.

Informations système et d’instance

Les offres groupées de support incluent des données de diagnostic sur les paramètres et l’environnement de votre instance, tels que les informations de version, la configuration du système, les détails de la licence et la sortie de la ghe-diagnostics commande. Pour obtenir la liste complète des informations de diagnostic, consultez Fourniture de données au support GitHub.

Fichiers de logs

Les offres groupées de support incluent les fichiers journaux des services système, des applications et des bases de données de votre instance. La quantité de données de journal collectées dépend du type de paquet. Pour en savoir plus sur les fichiers journaux disponibles, consultez À propos des journaux système.

Offres groupées standard et étendues

Il existe deux types de bundles de support. Un bundle standard est plus petit et plus rapide à générer, tandis qu’un bundle étendu fournit des données plus complètes pour la résolution des problèmes en profondeur.

	Offre groupée standard	Offre groupée étendue (-x indicateur)
Durée de journalisation	2 jours	8 jours
Fichiers journaux rotatifs	Exclu	Inclus
Décharges mémoire	Exclu	Inclus
Rapport d’utilisation du disque	Exclu	Inclus
Journaux de Hotpatch	Dernière version uniquement	Toutes les versions

Support GitHub indiquera le type de lot à générer. En cas de doute, générez un bundle étendu pour vous assurer que toutes les données de diagnostic sont disponibles. Vous pouvez également spécifier une durée de journal personnalisée à l’aide de l’indicateur --period (par exemple). --period '4 days'

État du service et métriques

Les offres groupées de support incluent l’état actuel de l’intégrité du service, les informations de processus, les métriques de performances et les fichiers de configuration pour les services clés s’exécutant sur votre instance.

Infos sur la disponibilité élevée

Si votre instance utilise la haute disponibilité ou le clustering, les offres groupées de support sont les suivantes :

• Informations sur le statut et le retard de la réplication
• Configuration du nœud de cluster
• Détails du cache réplica

Sécurité et confidentialité des données

Les offres groupées de support sont conçues pour aider à diagnostiquer les problèmes tout en protégeant les informations sensibles :

• Assainissement : les données sensibles telles que les mots de passe, les jetons et les clés privées sont supprimées ou obfusquées avant la collecte.
• Aucun contenu de référentiel : les offres groupées de support n’incluent pas le contenu de vos référentiels Git, tels que le code source, les données de validation ou le contenu du fichier.
• Données utilisateur : les offres groupées de support n’incluent pas d’informations de profil utilisateur au-delà de ce qui apparaît dans les journaux système.
• Informations de licence : le bundle inclut le nom de votre organisation et la référence de licence afin de Support GitHub pouvoir identifier votre instance.

Lorsque vous fournissez une archive d’assistance à Support GitHub, GitHub utilise les données uniquement pour traiter votre demande d’assistance. Pour plus d’informations sur la façon dont GitHub vous gérez vos données, consultez la GitHub Déclaration de confidentialité.

Taille du bundle de support et temps de génération

La taille du bundle de prise en charge et le temps de génération varient en fonction des points suivants :

• Taille et niveau d’activité de l’instance
• Nombre et taille des référentiels
• Durée écoulée depuis la dernière rotation du journal
• Indique si l’instance utilise le clustering ou la haute disponibilité

Les offres groupées de prise en charge classiques vont de quelques centaines de Mo à plusieurs Go. La génération d’un bundle peut prendre de quelques minutes pour les instances plus petites à plus d’une heure pour les instances très volumineuses ou fortement chargées.

Les lots de support volumineux peuvent affecter la performance de l'instance pendant la génération. Tenez compte des éléments suivants :

• Charge système : la génération d'un ensemble de support utilise des ressources processeur (CPU), mémoire et E/S disque.
• Synchronisation : si possible, générez des paquets de support pendant les heures creuses.
• Mode de maintenance : si votre instance rencontre des problèmes de performances graves, envisagez d’activer le mode maintenance avant de générer un bundle de support pour vous assurer qu’elle se termine correctement. Pour plus d’informations, consultez « Activation et planification du mode de maintenance ».

Réduction de l’impact sur les performances

La ghe-support-bundle commande s’exécute automatiquement au niveau de la priorité d’UC et d’E/S la plus faible, afin que les charges de travail de production soient prioritaires. Pour réduire davantage l’utilisation des ressources pendant la génération, vous pouvez utiliser ces indicateurs :

• --no-async (-n) : exécute des collections de manière séquentielle plutôt qu'en parallèle, ce qui réduit la contention des ressources.
• --num-jobs 1 (-l 1) : limite le parallélisme à un thread de collection unique. La valeur par défaut est un tiers du nombre d'UC disponibles.

Par exemple, pour générer et charger un bundle étendu avec un impact minimal sur les performances :

ghe-support-bundle -x -u --no-async --num-jobs 1

Relation avec d’autres outils de diagnostic

Les offres groupées de support fonctionnent en même temps que d’autres fonctionnalités de surveillance et de diagnostic :

Fichiers de diagnostic

La ghe-diagnostics commande génère un fichier de diagnostic plus petit contenant un sous-ensemble d’informations à partir d’un bundle de support complet. Les fichiers de diagnostic sont utiles pour les vérifications d’intégrité rapides ou lorsque vous ne pouvez pas générer une offre groupée de support complète. La sortie des diagnostics est également incluse dans chaque offre groupée de support.

Surveiller les tableaux de bord

La page Surveiller du Console de gestion fournit des métriques en temps réel et historiques concernant votre instance. Pour plus d’informations, consultez « À propos des tableaux de bord de surveillance ».

Génération et partage d’offres groupées de support

Vous pouvez générer et partager des packages d’assistance à l’aide de Console de gestion ou de la ligne de commande. Pour obtenir des instructions détaillées, consultez Fourniture de données au support GitHub.

Considérations relatives au clustering

Si vous utilisez GitHub Enterprise Server le clustering, vous pouvez générer :

• Offres groupées par nœud : bundles de support pour les nœuds individuels d'un cluster.
• Ensembles de clusters : un ensemble combiné de tous les nœuds du cluster à l'aide de ghe-cluster-support-bundle.

Support GitHub vous indiquera quel type de bundle générer en fonction du problème que vous analysez.

Échec de la génération du bundle de support

La cause la plus courante d'une génération de bundles échouée est un espace disque insuffisant en /data/user/tmp. Les bundles de support sont assemblés dans ce répertoire avant compression, il doit donc disposer de suffisamment d’espace pour contenir les données non compressées. Vérifiez l’espace disponible avant de générer un bundle :

df -h /data/user/tmp

Si la génération échoue ou prend un temps inhabituellement long, libérez de l’espace dans /data/user/tmp et réessayez. Si des problèmes persistent, contactez-le Support GitHub pour obtenir de l’aide. En guise d’alternative, vous pouvez générer un fichier de diagnostics plus petit à l’aide de la ghe-diagnostics commande.

Lectures complémentaires

• À propos des journaux système
• Utilitaires de ligne de commande
• Fourniture de données au support GitHub