Fournir des données au support GitHub

À propos des fichiers de diagnostic et des bundles de support

Pour vous aider à résoudre les problèmes liés à une instance GitHub Enterprise Server dans votre environnement, Support GitHub peut demander un ou plusieurs types de données.

Données	Format de fichier	Description
Fichier de diagnostic	Plaintext	Contient des informations sur les paramètres et l’environnement de l’instance.
Bundle de support	Archive	Contient un fichier de diagnostic et des fichiers journaux assainis des deux derniers jours par défaut.
Bundle de support étendu	Archive	Contient un fichier de diagnostic et des fichiers journaux assainis des huit 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

Les fichiers de diagnostic sont une vue d’ensemble des paramètres et de l’environnement d’une instance GitHub Enterprise Server qui contient :

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 créer un fichier de diagnostic à partir de la Management Console si vous ne disposez pas actuellement d’un accès SSH.

À 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. 1. Dans la barre latérale « Administrateur de site », cliquez sur Management Console .
Si vous y êtes invité, tapez votre mot de passe Management Console. 1. Dans la barre de navigation supérieure, cliquez sur Support.
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

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 site
github-logs/audit.log : journaux d’audit de GitHub Enterprise Server
babeld-logs/babeld.log : journaux de proxy Git
system-logs/haproxy.log : journaux HAProxy
elasticsearch-logs/github-enterprise.log : journaux Elasticsearch
configuration-logs/ghe-config.log : journaux de configuration de GitHub Enterprise Server
collectd/logs/collectd.log : journaux Collectd
mail-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 comprennent les journaux des deux derniers jours par défaut. Vous pouvez spécifier une durée exacte en heures ou en jours. Pour fournir les journaux des huit 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 Support GitHub, vous recevez un e-mail de confirmation qui contient un lien de référence à un ticket. Si le Support GitHub 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 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. 1. Dans la barre latérale « Administrateur de site », cliquez sur Management Console .
Si vous y êtes invité, tapez votre mot de passe Management Console. 1. Dans la barre de navigation supérieure, cliquez sur Support.
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 à votre instance GitHub Enterprise Server, et si vous disposez d’un accès à Internet.

Remarque : Si votre instance GitHub Enterprise Server est dans une configuration de géoréplication ou si votre instance est un cluster, vous devez utiliser la commande ghe-cluster-support-bundle pour récupérer le bundle de support. Pour plus d’informations, consultez « Utilitaires de ligne de commande ».

Téléchargez le bundle de support via SSH :
```
$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz
```
Pour plus d’informations sur la commande ghe-support-bundle, consultez « Utilitaires de 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. 1. Sous Settings, cliquez sur Licence .
Sous « Aide de GitHub Enterprise », cliquez sur Charger un bundle de support.
Sous « Sélectionner un compte d’entreprise », utilisez le menu déroulant pour sélectionner le compte associé du bundle de support.
Sous « Charger un bundle de support pour Support GitHub Enterprise », 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 à votre instance GitHub Enterprise Server.
Les connexions HTTPS sortantes sur le port TCP 443 sont autorisées de votre instance GitHub Enterprise Server 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'
```

Les bundles de support comprennent les journaux des deux derniers jours par défaut, alors que les bundles de support étendu comprennent les journaux des huit derniers jours. Si les événements investigués par le Support GitHub 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 à votre instance GitHub Enterprise Server, 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 commande ghe-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