Migration von collectd zu OpenTelemetry

GitHub Enterprise Server wechselt vom collectd-Metrik-Stack zu OpenTelemetry. Collectd wird mit Version 3.23 eingestellt, und das Upgrade auf 3.23 deaktiviert sie.

Migrationszeitplan

Version	Standard für neue Installationen	Verhalten beim Upgrade	Notizen
3.18	Collectd	Collectd	OpenTelemetry ist opt-in.
3.19 bis 3.20	OpenTelemetry	Vorhandene Metrikeinstellungen bleiben erhalten.	Instanzen, die collectd verwenden, können sich bei OpenTelemetry anmelden.
3.21 bis 3.22	OpenTelemetry	Upgrades von Versionen vor 3.21 aktivieren OpenTelemetry und deaktivieren collectd. Upgrades von 3.21 oder höher erhalten vorhandene Metrikeinstellungen.	Collectd kann weiterhin wieder aktiviert werden.
3.23 und neuer	OpenTelemetry	OpenTelemetry ist aktiviert und collectd ist deaktiviert.	Collectd wird eingestellt und kann nicht erneut aktiviert werden.

Vorbereiten der Migration

Bevor Sie migrieren, führen Sie die folgenden Vorbereitungen aus:

• Testen Sie die Migration auf einer Staginginstanz, bevor Sie sie in der Produktion anwenden.
• Identifizieren Sie die Überwachungsintegrationen, die von collectd-Metriken wie externen Dashboards und Warnungen abhängen.
• Wenn Sie beabsichtigen, beide Metrik-Stacks während eines Übergangszeitraums auszuführen, überprüfen Sie die Einschränkungen beim Ausführen beider Metrik-Stacks.

Migration zu OpenTelemetry

Sie können manuell auf Instanzen mit den Versionen 3.18 bis 3.22 zu OpenTelemetry migrieren. Wenn Ihre Instanz noch collectd verwendet, empfehlen wir eine Migration vor dem Upgrade auf 3.21 oder höher, damit Sie Ihre Überwachungseinrichtung im Voraus überprüfen können.

Durch das Upgrade von einer Version vor 3.21 auf 3.21 oder 3.22 wird OpenTelemetry automatisch aktiviert und collectd deaktiviert, aber collectd kann nach dem Upgrade wieder aktiviert werden. Durch das Upgrade auf 3.23 oder höher wird OpenTelemetry aktiviert und collectd dauerhaft deaktiviert.

Die Migration erfordert das Aktivieren von OpenTelemetry-Metriken und das Deaktivieren von collectd. Beide Einstellungen sind über Verwaltungskonsole oder über die Befehlszeile verfügbar.

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. Wählen Sie unter Metrics - Collectd die Option collectd-Metriken deaktivieren aus.

6. 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.

7. 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. Um OpenTelemetry-Metriken zu aktivieren und collectd zu deaktivieren, führen Sie die folgenden Befehle aus.

   ghe-config observability.metrics.next-enabled true
   ghe-config observability.metrics.legacy-disabled 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.

Beide Metrik-Stacks ausführen

Bei Version 3.18 bis 3.22 ist das gleichzeitige Ausführen der collectd- und OpenTelemetry-Stacks möglich, aber nicht empfohlen. Diese Konfiguration weist die folgenden Einschränkungen auf:

• Einige Metriknamen können unterschiedlich sein, um mit dem collectd-Format kompatibel zu bleiben.
• Einige OpenTelemetry-Metriken enthalten keine Labels.
• Erhöhte Ressourcenauslastung, um Metriken für beide Lösungen bereitzustellen.

Collectd wird in Version 3.23 eingestellt, sodass das Ausführen beider Stacks nach dem Upgrade nicht möglich ist.

Überprüfungen nach dem Upgrade

Nachdem die Konfiguration abgeschlossen ist, unabhängig davon, ob Sie manuell migriert oder ein Upgrade Ihre Instanz auf OpenTelemetry umgestellt hat:

• Überprüfen Sie, ob die Metriken sichtbar sind und auf der Registerkarte Monitoring des Verwaltungskonsole erfasst werden.
• Aktualisieren Sie Überwachungsintegrationen, die von collectd-Metriken abhängen. Informationen zum Verbinden externer Tools finden Sie unter Einrichten der externen Überwachung mit OpenTelemetry.
• Informationen zur Analyse von Metriken finden Sie unter Verwenden von Grafana zum Analysieren von OpenTelemetry-Metriken.

Anzeigen historischer collectd-Daten

Seit Patches 3.22.3, 3.21.8, 3.20.10 und 3.19.14 enthält die Registerkarte Überwachung collectd-Dashboards zum Anzeigen historischer Daten. Diese Dashboards zeigen collectd-Metriken an, die bis zum Zeitpunkt der Deaktivierung des collectd-Stacks aufgezeichnet wurden.