Skip to main content

Providing data to GitHub Support (Bereitstellen von Daten für GitHub Support)

Da der GitHub-Support keinen Zugriff auf deine Umgebung hat, benötigen wir unter Umständen einige zusätzliche Informationen von dir.

Wer kann dieses Feature verwenden?

Site administrators and enterprise owners can provide data to GitHub-Support.

Informationen zu Diagnosedateien und Supportbundles

Um Issues mit einer GitHub Enterprise Server-Instanz in deiner Umgebung zu beheben, fordert GitHub-Support möglicherweise einen oder mehrere Datentypen an.

DatenDateiformatBESCHREIBUNG
DiagnosedateiKlartextDiese Datei enthält Informationen zu den Einstellungen und der Umgebung der Instanz.
SupportbundleArchivierenDieses Bundle enthält eine Diagnosedatei und standardmäßig bereinigte Protokolldateien der letzten beiden Tage.
Erweitertes SupportbundleArchivierenDieses Bundle enthält eine Diagnosedatei und bereinigte Protokolldateien der letzten acht Tage.

Informationen zur Protokolldateibereinigung

Authentifizierungstoken, Schlüssel und Geheimnisse werden aus Protokolldateien in den folgenden Protokollverzeichnissen entfernt, die in einer Supportbundle- oder Diagnosedatei enthalten sind:

  • 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

Diagnosedateien erstellen und freigeben

Diagnosedateien bieten eine Übersicht über die Einstellungen und die Umgebung einer GitHub Enterprise Server-Instanz. Sie enthalten Folgendes:

  • Kundenlizenz-Informationen, einschließlich Firmenname, Ablaufdatum und Anzahl der Benutzerlizenzen
  • Versionsnummern und SHAs
  • VM-Architektur
  • Hostname, Privatmodus, SSL-Einstellungen
  • Lade- und Prozessauflistungen
  • Netzwerkeinstellungen
  • Authentifizierungsmethode und -details
  • Anzahl der Repositorys, Benutzer und andere Installationsdaten

Du kannst die Diagnose für deine Instanz über die Verwaltungskonsole oder durch Ausführen des Befehlszeilenprogramms ghe-diagnostics herunterladen.

Diagnosedatei über die Verwaltungskonsole erstellen

Du kannst eine Diagnosedatei über die Verwaltungskonsole erstellen, wenn du derzeit über keinen SSH-Zugriff verfügst.

  1. Klicke in einem Verwaltungskonto auf GitHub Enterprise Server und dann in der rechten oberen Ecke einer beliebigen Seite auf „“.

  2. Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.

  3. Wähle auf der Randleiste „ Websiteadministrator“ die Option Verwaltungskonsole aus.

  4. Wenn du mehrere Verwaltungskonsole-Benutzerkonten erstellt hast, wähle Websitedministrator mit Root-Berechtigungen oder Verwaltungskonsole-Benutzer aus. Weitere Informationen zu Verwaltungskonsole-Benutzerkonten findest du unter Verwalten des Zugriffs auf die Verwaltungskonsole.

  5. Gib deine Anmeldeinformationen für die Verwaltungskonsole ein. Klicke anschließend auf Weiter.

  6. Klicke auf der oberen Navigationsleiste auf Support.

    Screenshot der Kopfzeile der Verwaltungskonsole. Eine Registerkarte mit der Bezeichnung „Support“ ist mit einem orangefarbenen Rahmen hervorgehoben.

  7. Klicke auf Diagnoseinformationen herunterladen.

Diagnosedatei mithilfe von SSH erstellen

Du kannst diese Methode verwenden, ohne sich bei der Verwaltungskonsole anzumelden.

Verwende das Befehlszeilenprogramm ghe-diagnostics, um die Diagnose für deine Instanz abzurufen.

ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt

Support-Bundles erstellen und freigeben

Nachdem du deine Supportanfrage eingereicht hast, können wir Dich bitten, unserem Team ein Support-Paket bereitzustellen. Das Support-Bundle ist ein als .gzip komprimiertes TAR-Archiv, das Diagnosen und wichtige Protokolle deiner Instanz enthält, z. B.:

  • authentifizierungsbezogene Protokolle, die bei der Behebung von Authentifizierungsfehlern oder der Konfiguration von LDAP, CAS oder SAML hilfreich sein können,
  • Verwaltungskonsole-Protokoll,
  • github-logs/exceptions.log: Informationen zu 500 Fehlern auf der Website
  • github-logs/audit.log: GitHub Enterprise Server-Auditprotokolle
  • babeld-logs/babeld.log: Git-Proxyprotokolle
  • system-logs/haproxy.log: HAProxy-Protokolle
  • elasticsearch-logs/github-enterprise.log: Elasticsearch-Protokolle
  • configuration-logs/: GitHub Enterprise Server-Konfigurationsprotokolle
  • collectd/logs/collectd.log: Collectd-Protokolle
  • mail-logs/mail.log: SMTP-E-Mail-Übermittlungsprotokolle

Weitere Informationen findest du unter Informationen zum Überwachungsprotokoll für dein Unternehmen.

Supportbundle enthalten standardmäßig Protokolle der letzten beiden Tage. Du kannst eine genaue Dauer in Tagen angeben. Um Protokolle der letzten acht Tage bereitzustellen, kannst du ein erweitertes Supportbundle herunterladen. Weitere Informationen findest du unter Erstellen und Freigeben erweiterter Supportbundles.

Tipp: Wenn du den GitHub-Support kontaktierst, erhältst du eine Bestätigungs-E-Mail mit einem Ticket-Referenzlink. Wenn der GitHub-Support dich bittet, ein Support-Bundle hochzuladen, kannst du dazu den Ticket-Referenzlink verwenden.

Support-Bundle über die Verwaltungskonsole erstellen

Mit diesen Schritten kannst du ein Support-Bundle erstellen und freigeben, wenn du auf die webbasierte Verwaltungskonsole zugreifen kannst und einen ausgehenden Internetzugang hast.

  1. Klicke in einem Verwaltungskonto auf GitHub Enterprise Server und dann in der rechten oberen Ecke einer beliebigen Seite auf „“.

  2. Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.

  3. Wähle auf der Randleiste „ Websiteadministrator“ die Option Verwaltungskonsole aus.

  4. Wenn du mehrere Verwaltungskonsole-Benutzerkonten erstellt hast, wähle Websitedministrator mit Root-Berechtigungen oder Verwaltungskonsole-Benutzer aus. Weitere Informationen zu Verwaltungskonsole-Benutzerkonten findest du unter Verwalten des Zugriffs auf die Verwaltungskonsole.

  5. Gib deine Anmeldeinformationen für die Verwaltungskonsole ein. Klicke anschließend auf Weiter.

  6. Klicke auf der oberen Navigationsleiste auf Support.

    Screenshot der Kopfzeile der Verwaltungskonsole. Eine Registerkarte mit der Bezeichnung „Support“ ist mit einem orangefarbenen Rahmen hervorgehoben.

  7. Klicke auf Supportbundle herunterladen.

  8. Wenn dir ein Supporttechniker einen Uploadlink für dein Supportpaket mitgeteilt hat, verwende diesen Link. Andernfalls besuche https://support.github.com/, und melde dich (auf Aufforderung) bei einem Unternehmenskonto mit Supportanspruch an.

  9. Besuche https://support.github.com/uploads, und lade dein Supportbundle hoch.

Support-Bundle mithilfe von SSH erstellen

Mit diesen Schritten kannst du ein Supportbundle erstellen und freigeben, wenn du SSH-Zugriff auf Ihre GitHub Enterprise Server-Instance und ausgehenden Internetzugang hast.

Hinweis: Wenn für Ihre GitHub Enterprise Server-Instance eine Georeplikationskonfiguration verwendet wird oder deine Instanz ein Cluster ist, solltest du den Befehl ghe-cluster-support-bundle verwenden, um das Supportbundle abzurufen. Weitere Informationen findest du unter Befehlszeilenprogramme.

  1. Lade das Support-Bundle über SSH herunter:

    ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz
    

    Weitere Informationen zum Befehl ghe-support-bundle findest du unter Befehlszeilenprogramme.

  2. Wenn dir ein Supporttechniker einen Uploadlink für dein Supportpaket mitgeteilt hat, verwende diesen Link. Andernfalls besuche https://support.github.com/, und melde dich (auf Aufforderung) bei einem Unternehmenskonto mit Supportanspruch an.

  3. Besuche https://support.github.com/uploads, und lade dein Supportbundle hoch.

Ein Support-Paket wird mit deinem Unternehmenskonto hochladen

  1. Navigieren Sie zu GitHub Enterprise Cloud.

  2. Klicken Sie in der oberen rechten Ecke von GitHub auf Ihr Profilfoto und dann auf Ihre Unternehmen.

  3. Klicke in der Liste der Unternehmen auf das Unternehmen, das du anzeigen möchtest.

  4. Wähle auf der Randleiste des Unternehmenskontos die Option Einstellungen aus.

  5. Klicke unter Einstellungen auf Lizenz .

  6. Klicke unter GitHub Enterprise-Hilfe auf Supportbundle hochladen.

    Screenshot: Abschnitt „GitHub Enterprise-Hilfe“ auf der Seite mit den Unternehmenseinstellungen. Der Link zum Hochladen eines Supportbundles ist dunkelorange umrandet.

  7. Wähle unter „Unternehmenskonto auswählen“ im Dropdownmenü das zugehörige Konto für das Supportbundle aus.

  8. Klicke unter „Hochladen eines Supportbundles für GitHub Enterprise Support“ auf Datei auswählen, um dein Supportbundle auszuwählen, oder ziehe alternativ deine Supportbundledatei auf Datei auswählen.

  9. Klicke auf Hochladen.

Support-Bundle mithilfe von SSH direkt hochladen

Unter folgenden Voraussetzungen kannst du ein Support-Bundle direkt auf unseren Server hochladen:

  • Du hast SSH-Zugriff auf Ihre GitHub Enterprise Server-Instance.
  • Ausgehende HTTPS-Verbindungen über TCP-Port 443 sind von Ihre GitHub Enterprise Server-Instance zu enterprise-bundles.github.com und esbtoolsproduction.blob.core.windows.net zugelassen.
  1. Lade das Bundle auf unseren Support-Bundle-Server hoch:

    ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u'
    

Erweiterte Support-Bundles erstellen und freigeben

Supportbundle enthalten standardmäßig Protokolle der letzten beiden Tage, während erweiterte Supportbundle Protokolle der letzten acht Tage enthalten. Wenn die vom GitHub-Support untersuchten Ereignisse vor mehr als zwei Tagen aufgetreten sind, bitten wir dich möglicherweise, ein erweitertes Support-Bundle bereitzustellen. Du benötigst SSH-Zugriff, um ein erweitertes Bundle herunterzuladen. Du kannst ein erweitertes Bundle nicht über die Verwaltungskonsole herunterladen.

Damit die Pakete nicht zu groß werden, enthalten sie nur Protokolle, die nicht rotiert und komprimiert wurden. Die Protokollrotation unter GitHub Enterprise Server erfolgt in verschiedenen Intervallen (täglich oder wöchentlich) für verschiedene Protokolldateien, je nachdem, wie groß die Protokolle schätzungsweise sein werden.

Erweitertes Support-Bundle mithilfe von SSH erstellen

Mit diesen Schritten kannst du ein erweitertes Supportbundle erstellen und freigeben, wenn du SSH-Zugriff auf Ihre GitHub Enterprise Server-Instance und ausgehenden Internetzugang hast.

  1. Lade das erweiterte Supportbundle über SSH herunter, indem du dem ghe-support-bundle-Befehl das Flag -x hinzufügst:

    ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz
    
  2. Wenn dir ein Supporttechniker einen Uploadlink für dein Supportpaket mitgeteilt hat, verwende diesen Link. Andernfalls besuche https://support.github.com/, und melde dich (auf Aufforderung) bei einem Unternehmenskonto mit Supportanspruch an.

  3. Besuche https://support.github.com/uploads, und lade dein Supportbundle hoch.

Erweitertes Support-Bundle mithilfe von SSH direkt hochladen

Unter folgenden Voraussetzungen kannst du ein Support-Bundle direkt auf unseren Server hochladen:

  • Du hast SSH-Zugriff auf Ihre GitHub Enterprise Server-Instance.
  • Ausgehende HTTPS-Verbindungen über TCP-Port 443 sind von Ihre GitHub Enterprise Server-Instance zu enterprise-bundles.github.com und esbtoolsproduction.blob.core.windows.net zugelassen.
  1. Lade das Bundle auf unseren Support-Bundle-Server hoch:

    ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x'
    

Weiterführende Themen