Dieses Dokument wurde mithilfe automatisierter maschineller Übersetzungstechnologie übersetzt. Wir bemühen uns um korrekte Übersetzungen, übernehmen jedoch keine Gewähr für die Vollständigkeit, Richtigkeit oder Zuverlässigkeit der übersetzten Inhalte. Im Falle von Abweichungen ist die englische Originalversion maßgebend und stellt den verbindlichen Text dar.

Instrumentierung von Node.js-Anwendungen

Automatische Instrumentierung

Die automatische Instrumentierung für Node.js erfolgt durch das Einbinden der automatischen Instrumentierungs-JavaScript-Bibliotheken in Ihre Anwendung. Eine breite Palette von Bibliotheken und Frameworks wird unterstützt.

Die automatische Instrumentierung erfordert keine Änderungen an der Anwendung. Um es einzurichten, folgen Sie diesen Schritten:

  1. Fügen Sie das Open Telemetry Instrumentierungs-SDK zu Ihrer Anwendung hinzu:

    npm install --save @opentelemetry/api
npm install --save @opentelemetry/auto-instrumentations-node

  2. Aktualisieren Sie den Befehl, der Ihre Anwendung startet, um das SDK zu laden, entweder durch Aktualisierung des Docker-Image-Einstiegspunkts oder des Befehls oder durch Aktualisierung des command im Kubernetes-Manifest für Ihre Anwendung. Fügen Sie --require @opentelemetry/auto-instrumentations-node/register hinzu:

    node --require @opentelemetry/auto-instrumentations-node/register app.js

  3. Stellen Sie Ihre Anwendung mit den zusätzlichen Umgebungsvariablen zum Konfigurieren des Dienstnamens und des Exporter-Endpunkts bereit, unterstützte Protokolle sind gRPC und Protobuf über HTTP.

  4. Überprüfen Sie, ob SUSE Observability Traces und/oder Metriken empfängt, indem Sie nach den Metriken/Traces im Metriken-/Trace-Explorer für Ihren Dienstnamen suchen.

Für weitere Details konsultieren Sie bitte die Open Telemetry-Dokumentation.

Die automatisch über Umgebungsvariablen konfigurierte Instrumentierung unterstützt nur Traces, bis dieses Open Telemetry-Problem behoben ist. Um Metriken aus dem automatischen Instrumentierungscode zu aktivieren, sind Änderungen erforderlich. Bitte folgen Sie den Anweisungen in der Open Telemetry-Dokumentation, um diese Änderungen vorzunehmen.

Manuelle Instrumentierung

Manuelle Instrumentierung kann verwendet werden, wenn Sie Metriken, Traces oder Protokolle aus Teilen des Codes benötigen, die nicht von der automatischen Instrumentierung unterstützt werden. Zum Beispiel nicht unterstützte Bibliotheken, interner Code oder geschäftsbezogene Metriken.

Um diese Daten zu erfassen, müssen Sie Ihre Anwendung ändern.

  1. Fügen Sie das Open Telemetry SDK als Abhängigkeit hinzu.

  2. Fügen Sie Ihrer Anwendung Code hinzu, um Metriken, Spans oder Protokolle nach Bedarf zu erfassen.

Es gibt eine ausführliche Dokumentation dazu auf den Dokumentationsseiten des Open Telemetry Javascript SDK.

Stellen Sie sicher, dass Sie den OTLP-Exporter verwenden und den Exporter-Endpunkt korrekt im Code konfigurieren. Siehe auch die Open Telemetry-Dokumentation. Vorausgesetzt, Sie haben den Exporter wie dokumentiert eingerichtet, ist der Endpunkt, der konfiguriert werden muss, http://opentelemetry-collector.open-telemetry.svc.cluster.local:4317, unter Verwendung von gRPC. Siehe auch gRPC vs HTTP, falls gRPC problematisch ist.