OpenTelemetry-Metriken bilden die zukünftige Grundlage für das Monitoring und sind ab GitHub Enterprise Server 3.18 verfügbar. Dieser neue Überwachungsstapel bietet im Vergleich zum älteren Collectd-System verbesserte Beobachtbarkeits- und Verwaltungsfunktionen.
Metriken werden weiterhin standardmäßig gesammelt und sind in dieser Version vollständig unterstützt.
Voraussetzungen
- GitHub Enterprise Server 3.18 oder neuer
- Administrativer Zugriff auf die Verwaltungskonsole
- SSH-Zugang zu Ihrer 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. Bei Upgrades auf GitHub Enterprise Server 3.19 sind die Metriken von collectd immer noch standardmäßig aktiviert, aber Sie können zu OpenTelemetry-Metriken wechseln.
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.
Verwendung des Verwaltungskonsole zum Festlegen von Intervallen
-
Klicke in einem Verwaltungskonto für GitHub Enterprise Server in der rechten oberen Ecke einer beliebigen Seite auf .
-
Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.
-
Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.
-
Geben Sie in den Überwachungseinstellungen unter Metrik-Scrape-Intervall das gewünschte Intervall in Sekunden ein (z. B
60. ). -
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.
-
Warten Sie auf den Abschluss der Konfigurationsausführung.
Verwenden der Befehlszeile zum Festlegen von Intervallen
Verbinden Sie sich per SSH mit Ihrer GitHub Enterprise Server-Appliance 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 unter Verwendung der Verwaltungskonsole oder der Befehlszeile ändern.
Verwendung der Verwaltungskonsole zum Konfigurieren der Aufbewahrung
-
Klicke in einem Verwaltungskonto für GitHub Enterprise Server in der rechten oberen Ecke einer beliebigen Seite auf .
-
Wenn du dich nicht bereits auf der Seite „Websiteadministrator“ befindest, klicke in der oberen linken Ecke auf Websiteadministrator.
-
Klicke in der Randleiste „ Site admin“ auf Verwaltungskonsole.
-
Geben Sie in den Überwachungseinstellungen unter "Metrikaufbewahrung" den gewünschten Aufbewahrungszeitraum in Tagen ein (z. B
15. ). -
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.
-
Warten Sie auf den Abschluss der Konfigurationsausführung.
Verwenden der Befehlszeile zum Konfigurieren der Aufbewahrung
Verbinden Sie sich per SSH mit Ihrer GitHub Enterprise Server-Appliance 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
Verbinden Sie sich per SSH mit Ihrer GitHub Enterprise Server-Appliance 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
- Informationen zum Aktivieren erweiterter Überwachungsdashboards finden Sie unter Erweiterte Dashboards mit OpenTelemetry-Metriken
- Weitere Informationen zu OpenTelemetry-Metriken finden Sie unter Verwenden von Grafana zum Analysieren von OpenTelemetry-Metriken.
- Informationen zum Einrichten der externen Überwachung finden Sie unter Einrichten der externen Überwachung mit OpenTelemetry.