Zum Hauptinhalt springen
OpenTelemetry bietet umfangreiche Instrumentierung für viele beliebte Bibliotheken und Frameworks. Während der Installation von AppSignal und OpenTelemetry haben Sie möglicherweise bereits einige Instrumentierungspakete installiert, aber Sie müssen möglicherweise zusätzliche Instrumentierungspakete hinzufügen, um bestimmte Bibliotheken zu überwachen, die Ihre Anwendung verwendet. Dieser Leitfaden erklärt, wie Sie zusätzliche OpenTelemetry-Instrumentierungspakete identifizieren, installieren und konfigurieren, um eine bessere Observability-Abdeckung zu erreichen.

​
Warum zusätzliche Instrumentierung hinzufügen?

Ihre Anwendung verwendet möglicherweise Bibliotheken, die nicht durch die während des Setups installierten Instrumentierungspakete abgedeckt sind, wie z. B.:
  • Datenbank-Treiber
  • HTTP-Client-Bibliotheken
  • Message-Queue-Systeme
  • Benutzerdefinierte oder Nischenbibliotheken
Das Hinzufügen von Instrumentierung für diese Bibliotheken bietet ein vollständigeres Monitoring-Setup für alle Komponenten Ihrer Anwendung.

​
Allgemeine Schritte

In diesem Abschnitt werden die Schritte beschrieben, die für die meisten Sprachen erforderlich sind, um eine zusätzliche Bibliothek zu instrumentieren. Sprach-spezifische Schritte finden Sie im Abschnitt Sprach-spezifische Anweisungen.

​
1. Zu instrumentierende Bibliotheken identifizieren

Bestimmen Sie zunächst, welche Bibliotheken Ihre Anwendung verwendet, die Sie überwachen möchten. Häufige Kandidaten sind:
  • Datenbank-Clients (MySQL, PostgreSQL, MongoDB, Redis)
  • HTTP-Clients
  • Message Queues (RabbitMQ, Kafka, SQS)
  • Template-Engines

​
2. Instrumentierungspakete finden

Suchen Sie nach Instrumentierungspaketen in dieser Reihenfolge der Präferenz:
  1. Offizielle OpenTelemetry-Pakete - Gepflegt von der OpenTelemetry-Community
  2. OpenTelemetry-Contrib-Pakete - Von der Community beigesteuerte Instrumentierung
  3. Pakete von Drittanbietern - Stellen Sie sicher, dass Sie dem Maintainer vertrauen und überprüfen Sie den Code
Überprüfen Sie das OpenTelemetry-Registry für verfügbare Instrumentierungspakete. Beachten Sie, dass einige Bibliotheken möglicherweise selbst OpenTelemetry-Instrumentierung enthalten und kein weiteres Setup erforderlich ist.

​
3. Das Paket installieren

Sobald Sie ein relevantes Instrumentierungspaket gefunden haben, installieren Sie das Instrumentierungspaket mit dem Paketmanager Ihrer Sprache. Zum Beispiel: 
go get go.opentelemetry.io/contrib/instrumentation/net/http/otelhttp

​
4. Die Instrumentierung initialisieren

Je nach Sprache und SDK-Instrumentierungsmethode benötigen Instrumentierungspakete möglicherweise eine Initialisierung im Startcode Ihrer Anwendung. Dies beinhaltet typischerweise:
  • Importieren des Instrumentierungspakets
  • Aufrufen einer Initialisierungsfunktion
  • Konfigurieren paket-spezifischer Optionen
Für einige Sprachen, wie PHP und Java mit automatischen Instrumentierungen, ist dieser Schritt nicht notwendig. Es richtet die Instrumentierung automatisch ein, sofern nicht anders angewiesen.

​
5. Eingehende Daten prüfen

Überprüfen Sie nach der Installation, dass die Instrumentierung funktioniert:
  • Prüfen Sie, dass neue Spans über die instrumentierte Bibliothek in Ihren an AppSignal.com gemeldeten Traces erscheinen.
  • Bestätigen Sie, dass Metriken über die instrumentierte Bibliothek an AppSignal.com gemeldet werden.
  • Testen Sie Fehlerszenarien, um sicherzustellen, dass Fehler gemeldet werden.

​
Sprach-spezifische Anweisungen

Für detaillierte Anweisungen zum Hinzufügen von Instrumentierungspaketen für bestimmte Sprachen:

​
Fehlerbehebung

​
Häufige Probleme

  • Fehlende Traces: Stellen Sie sicher, dass die Instrumentierung initialisiert wird, bevor die Bibliothek verwendet wird.
  • Unvollständige Daten: Prüfen Sie, ob das Instrumentierungspaket Ihre Bibliotheksversion unterstützt.
  • Doppelte Spans: Vermeiden Sie es, dieselbe Bibliothek mehrfach zu instrumentieren.

​
Hilfe erhalten

Wenn Sie auf Probleme stoßen:
  1. Prüfen Sie die Dokumentation des Instrumentierungspakets
  2. Kontaktieren Sie den AppSignal-Support für Unterstützung