Skip to main content
Skip to content

Konfigurieren von OpenTelemetry für Ihre Instanz

Erfahren Sie, wie Sie die Sammlung von OpenTelemetry-Metriken in Ihrer GitHub Enterprise Server Instanz für eine verbesserte Überwachung und Observability konfigurieren.

OpenTelemetry-Metriken, die ab Version 3.18 verfügbar sind, sind die Grundlage für die Überwachung GitHub Enterprise Server. Dieser Überwachungsstapel bietet verbesserte Observability- und Verwaltungsfunktionen im Vergleich zum älteren collectd-System.

Neue Installationen von Version 3.19 und höher verwenden standardmäßig OpenTelemetry-Metriken. Auf Version 3.18 und bei Instanzen, die von früheren Versionen aktualisiert wurden, werden collectd-Metriken weiterhin standardmäßig erfasst und in dieser Version weiterhin unterstützt. Collectd wird in Version 3.23 eingestellt, und das Upgrade auf 3.23 deaktiviert sie. Die Migration zu OpenTelemetry wird empfohlen, bevor Instanzen aktualisiert werden, die weiterhin collectd verwenden. Siehe Migration von collectd zu OpenTelemetry.

Voraussetzungen

  • GitHub Enterprise Server 3.18 oder höher
  • Administrativer Zugriff auf Verwaltungskonsole
  • SSH-Zugriff auf Ihre GitHub Enterprise Server Appliance

Aktivieren von OpenTelemetry-Metriken

OpenTelemetry-Metriken sind standardmäßig für neue Installationen von GitHub Enterprise Server 3.19 und höher aktiviert. Instanzen, die von früheren Versionen aktualisiert wurden, haben weiterhin standardmäßig aktivierte collectd-Metriken. Informationen zum vollständigen Migrationsverfahren für Instanzen, die weiterhin collectd verwenden, einschließlich der Deaktivierung von collectd, finden Sie unter Migration von collectd zu OpenTelemetry.

Verwenden des Verwaltungskonsoles

  1. Klicke in einem Verwaltungskonto für GitHub Enterprise Server 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. Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.

  4. Wählen Sie in den Überwachungseinstellungen "OpenTelemetry aktivieren" aus.

  5. Klicke auf der Randleiste unter „Einstellungen“ auf Einstellungen speichern.

    Hinweis

    Durch das Speichern von Einstellungen in der Verwaltungskonsole werden Systemdienste neu gestartet, was zu einer für den Benutzer feststellbaren Downtime führen könnte.

  6. Warten Sie auf den Abschluss der Konfigurationsausführung.

Verwenden der Befehlszeile

  1. SSH in Ihre GitHub Enterprise Server-Instance. Wenn deine Instanz mehrere Knoten umfasst, wenn z. B. Hochverfügbarkeit oder Georeplikation konfiguriert ist, wird SSH im primären Knoten konfiguriert. Wenn du einen Cluster verwendest, kannst du SSH in einen beliebigen Knoten einfügen. Ersetzen Sie HOSTNAME durch den Hostnamen Ihrer Instanz bzw. durch den Hostnamen oder die IP-Adresse eines Knotens. Weitere Informationen finden Sie unter Auf die Verwaltungsshell (SSH) zugreifen.

    Shell
    ssh -p 122 admin@HOSTNAME
    
  2. Führen Sie den folgenden Befehl aus, um OpenTelemetry-Metriken zu aktivieren.

    ghe-config observability.metrics.next-enabled true
    
  3. Führe den folgenden Befehl aus, um die Konfiguration anzuwenden.

    Hinweis

    Während einer Konfigurationsausführung können die Dienste auf Ihre GitHub Enterprise Server-Instance neu gestartet werden, was zu kurzen Ausfallzeiten für Benutzer führen kann.

    Shell
    ghe-config-apply
    
  4. Warten Sie auf den Abschluss der Konfigurationsausführung.

Leistungsüberlegungen

Berücksichtigen Sie beim Konfigurieren von OpenTelemetry-Metriken die folgenden Leistungsfaktoren:

  • Sammlungshäufigkeit: Häufigere Sammlung erhöht die Systemlast
  • Datenaufbewahrung: Längere Aufbewahrungsfristen erfordern mehr Speicher
  • Benutzerdefinierte Exporteure: Zusätzliche Exporteure können die CPU- und Arbeitsspeicherauslastung erhöhen.
  • Netzwerkbandbreite: Der externe metrische Versand wirkt sich auf die Netzwerknutzung aus.

Konfigurieren der Metriksammlung

Nachdem Sie OpenTelemetry-Metriken aktiviert haben, können Sie verschiedene Aspekte des Metriksammlungsprozesses anpassen.

Festlegen von Sammlungsintervallen

Das Standardmäßige Metriksammlungsintervall beträgt 30 Sekunden. Sie können dies basierend auf Ihren Überwachungsanforderungen anpassen.

Wichtig

Das Festlegen kürzerer Intervalle erhöht die Genauigkeit der Metriken, erhöht aber auch die Speicheranforderungen und die Systemlast. Berücksichtigen Sie Ihre Systemressourcen und Überwachungsanforderungen, bevor Sie diese Einstellung anpassen.

Verwenden von Verwaltungskonsole zum Festlegen von Intervallen

  1. Klicke in einem Verwaltungskonto für GitHub Enterprise Server 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. Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.

  4. Geben Sie in den Überwachungseinstellungen unter Metrik-Scrape-Intervall das gewünschte Intervall in Sekunden ein (z. B 60. ).

  5. Klicke auf der Randleiste unter „Einstellungen“ auf Einstellungen speichern.

    Hinweis

    Durch das Speichern von Einstellungen in der Verwaltungskonsole werden Systemdienste neu gestartet, was zu einer für den Benutzer feststellbaren Downtime führen könnte.

  6. Warten Sie auf den Abschluss der Konfigurationsausführung.

Verwenden der Befehlszeile zum Festlegen von Intervallen

Melden Sie sich per SSH an Ihrer GitHub Enterprise Server Appliance an und führen Sie die folgenden Befehle aus:

# Set scrape interval to 60 seconds
ghe-config observability.metrics.interval 60
ghe-config-apply

Konfigurieren der Datenaufbewahrung

Metrikdaten werden standardmäßig 30 Tage lang aufbewahrt. Sie können diese Einstellung entweder über die Verwaltungskonsole oder die Befehlszeile ändern.

Verwenden von Verwaltungskonsole zum Konfigurieren der Aufbewahrung

  1. Klicke in einem Verwaltungskonto für GitHub Enterprise Server 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. Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.

  4. Geben Sie in den Überwachungseinstellungen unter "Metrikaufbewahrung" den gewünschten Aufbewahrungszeitraum in Tagen ein (z. B 15. ).

  5. Klicke auf der Randleiste unter „Einstellungen“ auf Einstellungen speichern.

    Hinweis

    Durch das Speichern von Einstellungen in der Verwaltungskonsole werden Systemdienste neu gestartet, was zu einer für den Benutzer feststellbaren Downtime führen könnte.

  6. Warten Sie auf den Abschluss der Konfigurationsausführung.

Verwenden der Befehlszeile zum Konfigurieren der Aufbewahrung

Melden Sie sich per SSH an Ihrer GitHub Enterprise Server Appliance an und führen Sie die folgenden Befehle aus:

# Set retention to 15 days
ghe-config observability.metrics.retention 15
ghe-config-apply

Konfigurieren der Ausführlichkeitsstufe für die interne Telemetrie

Der OpenTelemetry-Collector generiert seine eigenen internen Telemetriedaten zur Überwachung der Gesundheit und Leistung des Collectors selbst. Sie können die Ausführlichkeit dieser internen Telemetrie mithilfe der Befehlszeile konfigurieren.

Die verfügbaren Telemetriestufen sind:

  • none: Deaktiviert die interne Telemetrie
  • basic: Stellt grundlegende Telemetriedaten bereit (Standard)
  • normal: Stellt Standardmäßige Telemetriedaten bereit.
  • detailed: Liefert ausführliche Telemetriedaten für die Fehlersuche

Melden Sie sich per SSH an Ihrer GitHub Enterprise Server Appliance an und führen Sie die folgenden Befehle aus:

# Set internal telemetry level to normal
ghe-config observability.metrics.internal-otel-telemetry-level normal
ghe-config-apply

Hinweis

Höhere Telemetriestufen bieten detailliertere Informationen zu den internen Abläufen des Sammlers, erhöhen aber auch den Ressourcenverbrauch. Die Stufe basic wird für Produktionsumgebungen empfohlen, es sei denn, Sie müssen Probleme mit dem Collector beheben.

Konfigurationsprobleme beheben

Wenn Probleme mit der OpenTelemetry-Konfiguration auftreten, können Sie die folgenden Informationen beim Identifizieren und Beheben häufiger Probleme unterstützen.

Allgemeine Konfigurationsprobleme

  • Dienststartfehler: Überprüfen der Systemprotokolle auf Fehlermeldungen
  • Ressourceneinschränkungen: Überwachen von Systemressourcen beim Anpassen von Sammlungsintervallen

Anzeigen lokaler Protokolle

SSH auf den Knoten, den Sie debuggen wollen, und führen Sie diese Befehle aus:

Anzeigen von OpenTelemetry-Sammelprotokollen:

sudo journalctl -u otelcol-contrib -f

VictoriaMetrics-Protokolle anzeigen:

sudo journalctl -u victoriametrics -f

Nächste Schritte