À propos des fichiers de diagnostic et des bundles de support
GitHub Support peut vous demander de fournir des données supplémentaires sous la forme de fichiers journaux assainis. Il existe trois types de fichier journal que vous pouvez être invité à fournir.
Les fichiers de diagnostic contiennent des informations sur les paramètres et l’environnement d’une instance de GitHub Enterprise Server. Les bundles de support contiennent les diagnostics et les journaux des deux derniers jours. Les bundles de support étendu contiennent également des diagnostics et des journaux, mais qui portent sur les sept derniers jours.
À propos de l’assainissement des fichiers journaux
Les jetons d’authentification, les clés et les secrets sont supprimés des fichiers journaux dans les répertoires de journaux suivants, qui sont présents dans un bundle de support ou un fichier de diagnostic :
alambic-logs
babeld-logs
codeload-logs
enterprise-manage-logs
github-logs
hookshot-logs
lfs-server-logs
semiotic-logs
task-dispatcher-logs
pages-logs
registry-logs
render-logs
svn-bridge-logs
Création et partage de fichiers de diagnostic
Les fichiers de diagnostic sont une vue d’ensemble des paramètres et de l’environnement d’une instance de GitHub Enterprise Server. Ils contiennent les éléments suivants :
- Informations sur la licence client, notamment le nom de l’entreprise, la date d’expiration et le nombre de licences utilisateur
- Numéros de version et SHA
- Architecture de machine virtuelle
- Nom d’hôte, mode privé, paramètres SSL
- Listes des chargements et des processus
- Paramètres réseau
- Méthode d’authentification et détails
- Nombre de dépôts, d’utilisateurs et autres données d’installation
Vous pouvez télécharger les diagnostics pour votre instance à partir de la Management Console ou en exécutant l’utilitaire en ligne de commande ghe-diagnostics
.
Création d’un fichier de diagnostic à partir de la Management Console
Vous pouvez utiliser cette méthode si vous n’avez pas votre clé SSH à disposition.
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur dans le coin supérieur droit 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.
1. Dans la barre latérale gauche, cliquez sur Management Console .
1. Si vous y êtes invité, tapez votre mot de passe Management Console.
4. Dans la partie supérieure de la Management Console, cliquez sur Maintenance.
-
Cliquez sur Télécharger les informations de diagnostic.
Création d’un fichier de diagnostic via SSH
Vous pouvez utiliser cette méthode sans vous connecter à la Management Console.
Utilisez l’utilitaire en ligne de commande ghe-diagnostics pour récupérer les diagnostics de votre instance.
$ ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt
Création et partage de bundles de support
Une fois que vous avez envoyé votre demande de support, nous pouvons vous demander de partager un bundle de support avec notre équipe. Le bundle de support est une archive tar compressée avec gzip, qui comprend les diagnostics et les journaux importants de votre instance, par exemple :
- Journaux liés à l’authentification, qui peuvent être utiles pour résoudre les erreurs d’authentification ou configurer LDAP, CAS ou SAML
- Journal de la Management Console
github-logs/exceptions.log
: informations portant sur 500 erreurs rencontrées sur le sitegithub-logs/audit.log
: journaux d’audit de GitHub Enterprise Serverbabeld-logs/babeld.log
: journaux de proxy Gitsystem-logs/haproxy.log
: journaux HAProxyelasticsearch-logs/github-enterprise.log
: journaux Elasticsearchconfiguration-logs/ghe-config.log
: journaux de configuration de GitHub Enterprise Servercollectd/logs/collectd.log
: journaux Collectdmail-logs/mail.log
: journaux de remise d’e-mail SMTP
Pour plus d’informations, consultez « À propos du journal d’audit de votre entreprise ».
Les bundles de support incluent les journaux des deux derniers jours. Pour obtenir les journaux des sept derniers jours, vous pouvez télécharger un bundle de support étendu. Pour plus d’informations, consultez « Création et partage de bundles de support étendu ».
Conseil : Quand vous contactez le GitHub Support, vous recevez un e-mail de confirmation qui contient un lien de référence à un ticket. Si le GitHub Support vous demande de charger un bundle de support, vous pouvez le faire en utilisant le lien de référence au ticket.
Création d’un bundle de support à partir de la Management Console
Vous pouvez suivre ces étapes pour créer et partager un bundle de support si vous pouvez accéder à la Management Console web, et si vous disposez d’un accès à Internet sortant.
-
À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur dans le coin supérieur droit 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.
1. Dans la barre latérale gauche, cliquez sur Management Console .
1. Si vous y êtes invité, tapez votre mot de passe Management Console.
4. Dans la partie supérieure de la Management Console, cliquez sur Maintenance.
-
Cliquez sur Télécharger le bundle de support.
-
Si un ingénieur du support vous a fourni un lien de chargement pour votre bundle de support, utilisez ce lien. Sinon, rendez-vous sur https://support.github.com/ et connectez-vous (si vous y êtes invité) à un compte d’entreprise qui bénéficie du support. 1. Visitez https://support.github.com/uploads et chargez votre bundle de support.
Création d’un bundle de support via SSH
Vous pouvez suivre ces étapes pour créer et partager un bundle de support si vous avez un accès SSH à your GitHub Enterprise Server instance, et si vous disposez d’un accès à Internet.
Remarque : Si vous utilisez une configuration de géoréplication ou le clustering GitHub Enterprise, vous devez utiliser la commande ghe-cluster-support-bundle
pour récupérer le bundle de support. Pour plus d’informations, consultez « Utilitaires en ligne de commande ».
- Téléchargez le bundle de support via SSH :
Pour plus d’informations sur la commande$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz
ghe-support-bundle
, consultez « Utilitaires en ligne de commande ». - Si un ingénieur du support vous a fourni un lien de chargement pour votre bundle de support, utilisez ce lien. Sinon, rendez-vous sur https://support.github.com/ et connectez-vous (si vous y êtes invité) à un compte d’entreprise qui bénéficie du support. 1. Visitez https://support.github.com/uploads et chargez votre bundle de support.
Chargement d’un bundle de support à l’aide de votre compte d’entreprise
-
Accédez à GitHub.com.
-
En haut à droite de GitHub.com, cliquez sur votre photo de profil, puis sur Vos entreprises.
-
Dans la liste des entreprises, cliquez sur l’entreprise que vous souhaitez afficher.
1. Dans la barre latérale du compte d’entreprise, cliquez sur Paramètres.
-
Dans la barre latérale gauche, cliquez sur Gestion des licences Enterprise.
-
Sous « Aide de GitHub Enterprise », cliquez sur Charger un bundle de support.
-
Sous « Sélectionner un compte d’entreprise », dans le menu déroulant, sélectionnez le compte associé au bundle de support.
-
Sous « Charger un bundle de support pour GitHub Enterprise Support », pour sélectionner votre bundle de support, cliquez sur Choisir un fichier, ou faites glisser votre fichier de bundle de support vers Choisir un fichier.
-
Cliquez sur Télécharger.
Chargement d’un bundle de support directement via SSH
Vous pouvez charger directement un bundle de support sur notre serveur si :
- Vous disposez d’un accès SSH à your GitHub Enterprise Server instance.
- Les connexions HTTPS sortantes sur le port TCP 443 sont autorisées de your GitHub Enterprise Server instance vers enterprise-bundles.github.com et esbtoolsproduction.blob.core.windows.net.
- Chargez le bundle sur notre serveur de bundles de support :
$ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'
Création et partage de bundles de support étendu
Les bundles de support incluent les journaux des deux derniers jours, alors que les bundles de support étendu incluent les journaux des sept derniers jours. Si les événements investigués par le GitHub Support se sont produits depuis plus de deux jours, nous pouvons vous demander de partager un bundle de support étendu. Vous avez besoin d’un accès SSH pour télécharger un bundle étendu. Vous ne pouvez pas télécharger de bundle étendu à partir de la Management Console.
Pour éviter que les bundles ne deviennent trop volumineux, ils contiennent uniquement les journaux qui n’ont pas fait l’objet d’une rotation et qui n’ont pas été compressés. La rotation des journaux sur GitHub Enterprise Server se produit à différentes fréquences (quotidiennes ou hebdomadaires) pour différents fichiers journaux, en fonction de la taille attendue des journaux.
Création d’un bundle de support étendu via SSH
Vous pouvez suivre ces étapes pour créer et partager un bundle de support étendu si vous avez un accès SSH à your GitHub Enterprise Server instance, et si vous disposez d’un accès à Internet.
- Téléchargez le bundle de support étendu via SSH en ajoutant l’indicateur
-x
à la commandeghe-support-bundle
:$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz
- Si un ingénieur du support vous a fourni un lien de chargement pour votre bundle de support, utilisez ce lien. Sinon, rendez-vous sur https://support.github.com/ et connectez-vous (si vous y êtes invité) à un compte d’entreprise qui bénéficie du support. 1. Visitez https://support.github.com/uploads et chargez votre bundle de support.
Chargement d’un bundle de support étendu directement via SSH
Vous pouvez charger directement un bundle de support sur notre serveur si :
- Vous disposez d’un accès SSH à your GitHub Enterprise Server instance.
- Les connexions HTTPS sortantes sur le port TCP 443 sont autorisées de your GitHub Enterprise Server instance vers enterprise-bundles.github.com et esbtoolsproduction.blob.core.windows.net.
- Chargez le bundle sur notre serveur de bundles de support :
$ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'