Informationen zu Supportpaketen für GitHub Enterprise Server

Informationen zu Supportpaketen

Ein Support-Bundle ist ein komprimiertes Archiv von Diagnosedaten Ihrer GitHub Enterprise Server-Instanz. Sie können Supportpakete verwenden, um mit GitHub-Support an der Lösung von Problemen zu arbeiten und Berichte zur Systemgesundheit zu erstellen, die Konfiguration, Gesundheit und Aktivität Ihrer Instanz zusammenfassen.

Zeitpunkt der Generierung eines Supportpakets

Generieren Sie ein Supportpaket in mehreren Szenarien:

Supportticket Untersuchung

GitHub-Support kann ein Supportpaket anfordern, um Leistungsprobleme, Dienstfehler, Authentifizierungsprobleme oder andere betriebliche Probleme zu untersuchen. Öffnen Sie zuerst ein Supportticket, generieren Sie dann das Bündel, und schließen Sie Ihre Ticketnummer ein, um es Ihrem Fall zuzuordnen. Ausführliche Informationen findest du unter Befehlszeilenwerkzeuge.

Gesundheitscheck-Analyse

Sie können ein Support-Bundle erstellen, um einen Bericht zur Health Check zu erstellen. Integritätsprüfungen analysieren Ihre Supportbundledaten und berichten über die Integrität, Sicherheit, Git-Vorgänge und API-Nutzung Ihrer Instanz. Weitere Informationen findest du unter Generieren einer Gesundheitsprüfung für Ihr Unternehmen.

Inhalt eines Supportpakets

Supportbundle enthalten mehrere Kategorien von Daten aus Ihrer Instanz. Der genaue Inhalt hängt von Ihrer GitHub Enterprise Server Version und Konfiguration ab.

System- und Instanzinformationen

Zu den Supportpaketen gehören Diagnosedaten zu den Einstellungen und der Umgebung Ihrer Instanz, z. B. Versionsinformationen, Systemkonfiguration, Lizenzdetails und die Ausgabe des ghe-diagnostics Befehls. Eine vollständige Liste der Diagnoseinformationen finden Sie unter Bereitstellen von Daten für GitHub Support.

Protokolldateien

Zu den Supportpaketen gehören Protokolldateien aus den Systemdiensten, Anwendungen und Datenbanken Ihrer Instanz. Die Menge der gesammelten Protokolldaten hängt vom Bündeltyp ab. Weitere Informationen zu verfügbaren Protokolldateien finden Sie unter Informationen zu Systemprotokollen.

Standard- und erweiterte Bündel

Es gibt zwei Arten von Supportpaketen. Ein Standardbundle ist kleiner und schneller zu generieren, während ein erweitertes Bundle umfassendere Daten zur ausführlicheren Problembehandlung bereitstellt.

	Standardpaket	Erweitertes Bündel (`-x` Kennzeichnung)

          **Protokolldauer** | 2 Tage | 8 Tage |

GitHub-Support gibt an, welche Art von Bundle generiert werden soll. Generieren Sie im Zweifelsfall ein erweitertes Bundle, um sicherzustellen, dass alle Diagnosedaten verfügbar sind. Sie können auch eine benutzerdefinierte Protokolldauer mithilfe des --period Flags angeben (z. B --period '4 days'. ).

Dienststatus und Metriken

Supportpakete umfassen den aktuellen Dienststatus, Prozessinformationen, Leistungsmetriken und Konfigurationsdateien für wichtige Dienste, die auf Ihrer Instanz ausgeführt werden.

Informationen über hohe Verfügbarkeit

Wenn Ihre Instanz hohe Verfügbarkeit oder Clustering verwendet, umfassen Supportpakete:

Replikationsstatus und Verzögerungsinformationen
Clusterknotenkonfiguration
Details zum Cache-Replikat

Datenschutz und Sicherheit

Supportpakete sind so konzipiert, dass Sie Probleme beim Schutz vertraulicher Informationen diagnostizieren können:

        **Bereinigung**: Vertrauliche Daten wie Kennwörter, Token und private Schlüssel werden vor der Sammlung entfernt oder verschleiert.

        **Kein Repositoryinhalt**: Supportpakete enthalten nicht die Inhalte Ihrer Git-Repositorys, z. B. Quellcode, Commitdaten oder Dateiinhalte.

        **Benutzerdaten**: Support-Bundles enthalten keine Benutzerprofilinformationen, die über das hinausgehen, was in Systemprotokollen angezeigt wird.

        **Lizenzinformationen**: Das Bündel enthält den Namen und die Lizenzreferenz Ihrer Organisation, sodass GitHub-Support Ihre Instanz identifizieren können.

Wenn Sie ein Supportbundle für GitHub-Support bereitstellen, verwendet GitHub die Daten nur, um Ihre Supportanfrage zu adressieren. Ausführliche Informationen dazu, wie GitHub Ihre Daten verarbeitet, finden Sie in den Datenschutzbestimmungen zu GitHub

Größe des Support-Bundles und Generierungszeit

Die Unterstützungspaketgröße und -generierungszeit variieren je nach:

Instanzgröße und Aktivitätsstufe
Anzahl und Größe von Repositorys
Zeitdauer seit der letzten Log-Drehung
Gibt an, ob die Instanz Clustering oder hohe Verfügbarkeit verwendet.

Typische Supportpakete reichen von ein paar hundert MB bis zu mehreren GB. Das Erstellen eines Bundles kann bei kleineren Instanzen ein paar Minuten dauern, während es bei sehr großen oder stark ausgelasteten Instanzen über eine Stunde dauern kann.

Große Supportpakete können sich auf die Instanzleistung während der Generierung auswirken. Beachte Folgendes:

        **Systemlast**: Beim Generieren eines Supportpakets werden CPU-, Arbeitsspeicher- und E/A-Ressourcen verwendet.

        **Zeitpunkt**: Generieren Sie nach Möglichkeit Supportpakete außerhalb der Spitzenzeiten.

        **Wartungsmodus**: Wenn Ihre Instanz schwerwiegende Leistungsprobleme aufweist, sollten Sie den Wartungsmodus aktivieren, bevor Sie ein Supportpaket generieren, um sicherzustellen, dass sie erfolgreich abgeschlossen wird. Weitere Informationen findest du unter [AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode).

Verringern der Leistungseinbußen

Der ghe-support-bundle Befehl wird automatisch mit der niedrigsten CPU- und E/A-Priorität ausgeführt, sodass Produktionsworkloads Vorrang haben. Um die Ressourcennutzung während der Generierung weiter zu reduzieren, können Sie diese Flags verwenden:

        `--no-async` (`-n`): Führt Operationen sequenziell statt parallel aus, wodurch die Ressourcenkonkurrenz verringert wird.

        `--num-jobs 1` (`-l 1`): Beschränkt die Parallelität auf einen einzelnen Sammlungsthread. Der Standardwert ist ein Drittel der verfügbaren CPU-Anzahl.

Um z. B. ein erweitertes Bundle mit minimalen Leistungseinbußen zu generieren und hochzuladen:

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

Beziehung zu anderen Diagnosetools

Supportpakete funktionieren zusammen mit anderen Überwachungs- und Diagnosefeatures:

Diagnosedateien

Der ghe-diagnostics Befehl generiert eine kleinere Diagnosedatei, die eine Teilmenge von Informationen aus einem vollständigen Supportbundle enthält. Diagnosedateien sind nützlich für schnelle Gesundheitsprüfungen oder wenn Sie kein vollständiges Support-Bundle erstellen können. Die Diagnoseausgabe ist auch in jedem Supportbundle enthalten.

Überwachen von Dashboards

Die Seite "Monitoring" in der Verwaltungskonsole bietet Echtzeit- und Verlaufsmetriken zu Ihrer Instanz. Weitere Informationen findest du unter Über die dashboard für die Überwachung.

Sie können Support-Bundles mithilfe der Verwaltungskonsole oder der Befehlszeile generieren und freigeben. Ausführliche Anweisungen findest du unter Bereitstellen von Daten für GitHub Support.

Überlegungen zum Clustering

Wenn Sie die GitHub Enterprise Server Clustering-Funktion verwenden, können Sie Folgendes generieren:

Pro Knotenbundle: Unterstützungspakete für einzelne Clusterknoten.

        **Clusterbundle**: Ein kombiniertes Bundle von allen Clusterknoten mithilfe von `ghe-cluster-support-bundle`.

GitHub-Support wird empfehlen, welche Art von Paket basierend auf dem von Ihnen untersuchten Problem generiert werden soll.

Fehler bei der Generierung des Support-Bundles

Die häufigste Ursache für die Generierung eines fehlgeschlagenen Bundles ist nicht genügend freier Speicherplatz in /data/user/tmp. Supportbundle werden in diesem Verzeichnis vor der Komprimierung zusammengestellt, sodass genügend Platz benötigt wird, um die nicht komprimierten Daten zu speichern. Überprüfen Sie den verfügbaren Speicherplatz, bevor Sie ein Bündel generieren:

df -h /data/user/tmp

Wenn die Generation fehlschlägt oder ungewöhnlich lange dauert, geben Sie Speicherplatz in /data/user/tmp frei, und versuchen Sie es erneut. Wenn Probleme weiterhin bestehen, wenden Sie sich an GitHub-Support, um Hilfe zu erhalten. Alternativ können Sie eine kleinere Diagnosedatei mit dem ghe-diagnostics Befehl generieren.

Weiterführende Lektüre

        [AUTOTITLE](/admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs)

        [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-support-bundle)

        [AUTOTITLE](/support/contacting-github-support/providing-data-to-github-support)

Informationen zu Supportpaketen für GitHub Enterprise Server

In diesem Artikel