In diesem Dokument wird die Telemetry API (OTLP) beschrieben, die das OpenTelemetry OTLP-Protokoll implementiert. Diese API ist für die Verwendung mit Anwendungen konzipiert, die mit einem der OpenTelemetry SDKs instrumentiert werden.
Gründe für die Verwendung der Telemetry API
OpenTelemetry ist ein von Google Cloudunterstütztes Open-Source-Projekt mit Google Cloud-Entwicklern, die für die Unterstützung beim Erfassen und Visualisieren Ihrer Tracedaten sorgen.
Wenn Sie die Telemetry API verwenden, werden Ihre Daten in einem Format gespeichert, das im Allgemeinen mit den von OpenTelemetry OTLP Protocol definierten Protobuf-Dateien übereinstimmt. Felder können jedoch vor dem Speichern von einem OpenTelemetry-spezifischen Datentyp in einen JSON-Datentyp konvertiert werden. Außerdem gelten die Limits für die Telemetry API. Diese Limits sind oft großzügiger als die für die Cloud Trace API. Schließlich ist Ihre Instrumentierung nicht von einem Google Cloud-spezifischen Exporteur abhängig.
Weitere Informationen zum Speicherformat finden Sie unter Schema für Tracedaten.
Wann sollte die Telemetry API verwendet werden?
Wir empfehlen, Ihre Trace-Daten mithilfe der Telemetry API an Ihr Google Cloud -Projekt zu senden. Diese API ist mit dem Open-Source-Ökosystem von OpenTelemetry kompatibel und ihre Limits sind oft großzügiger als die der Cloud Trace API, die eine proprietäreGoogle Cloud API ist. Einige Funktionen wie Application Monitoring basieren auf Informationen, die nur verfügbar sind, wenn Tracedaten an die Telemetry API gesendet werden.
Wenn Sie Ihre Anwendungen so instrumentieren, dass sie Tracedaten an IhrGoogle Cloud -Projekt senden, empfehlen wir, eine der folgenden Aktionen auszuführen:
- Verwenden Sie einen Exporter, der OTLP in einen Collector schreibt, der Ihre Trace-Daten dann an die Telemetry API sendet.
- Verwenden Sie einen In-Process-OTLP-Exporter, der von einer OpenTelemetry-Bibliothek unterstützt wird und Telemetrie an die Telemetry API sendet. Es gibt keinen Collector mit dieser Konfiguration.
Informationen zur Verwendung der Telemetry API finden Sie unter Vom Cloud Trace-Exporter zum OTLP-Endpunkt migrieren.
Wo Sie aufgenommene Daten ansehen können
Trace-Daten, die über die Telemetry API aufgenommen werden, können auf der Seite Trace Explorer aufgerufen werden. Informationen zum Ansehen Ihrer Trace-Daten finden Sie unter Traces finden und ansehen.
Authentifizierung
Exporter müssen autorisiert sein, Daten an Ihr Google Cloud -Projekt zu senden. Sie können den Exporter beispielsweise mit Ihren Google Cloud Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) konfigurieren, indem Sie Ihrer Anwendung eine sprachspezifische Google Auth Library hinzufügen. Weitere Informationen und Beispielcode finden Sie unter Authentifizierung konfigurieren.
Unterstützung durch VPC Service Controls
Der Telemetry API-Dienst mit dem Dienstnamen telemetry.googleapis.com ist ein von VPC Service Controls unterstützter Dienst. Alle VPC Service Controls-Einschränkungen, die Sie für den Telemetry API-Dienst erstellen, gelten nur für diesen Dienst. Diese Einschränkungen gelten nicht für andere Dienste, einschließlich Dienste wie cloudtrace.googleapis.com, in die auch Tracedaten aufgenommen werden können.
Hier finden Sie weitere Informationen:
Cloud Trace und Datenstandort
Wenn Sie Assured Workloads verwenden, weil Sie Anforderungen an den Datenstandort oder Impact Level 4 (IL4) haben, sollten Sie die Telemetry API nicht zum Senden von Trace-Spans verwenden.