Telemetry API (OTLP) – Übersicht

In diesem Dokument wird die Telemetry API (OTLP) beschrieben, die das OpenTelemetry Line Protocol implementiert. Diese API ist für die Verwendung mit Anwendungen konzipiert, die mit einem der OpenTelemetry SDKs instrumentiert wurden oder einen OpenTelemetry Collector verwenden.

OpenTelemetry ist ein von Google Cloudunterstütztes Open-Source-Projekt mit Google Cloud-Entwicklern, die für die Unterstützung bei der Aufnahme und Visualisierung Ihrer Telemetriedaten sorgen.

Weitere Informationen zu dieser API finden Sie in den folgenden Referenzdokumenten:

Best Practices

Wenn Sie Ihre Anwendungen instrumentieren, um Tracedaten an IhrGoogle Cloud -Projekt zu senden, empfehlen wir, einen Exporter zu verwenden, der OTLP-formatierte Daten in einen Collector schreibt, der Ihre Tracedaten dann an die Telemetry API sendet. Geben Sie in Ihrem Collector nur die Stamm-URL an:

exporters:
  otlphttp:
    encoding: proto
    endpoint: https://telemetry.googleapis.com

OpenTelemetry erkennt den Datentyp und hängt automatisch /v1/traces, /v1/metrics oder /v1/logs an. Weitere Informationen finden Sie unter OTLP/HTTP-Anfrage.

Beispiele für den Export von Trace- oder Messwertdaten in die Telemetry API finden Sie in den folgenden Dokumenten:

Wenn Sie keinen Collector verwenden können, können Sie eine OpenTelemetry-Bibliothek mit einem In-Process-OTLP-Exporter verwenden, um Telemetrie an die Telemetry API zu senden. Informationen zum direkten Exportieren von Trace-Daten finden Sie unter Cloud Trace-Exporter für den OTLP-Endpunkt.

Authentifizierung

Sie müssen Ihre Exporter mit den Anmeldedaten konfigurieren, die zum Senden von Daten an Ihr Google Cloud -Projekt erforderlich sind. Wenn Sie beispielsweise Collectors verwenden, verwenden Sie in der Regel auch die Erweiterung googleclientauth, um sich mit Google-Anmeldedaten zu authentifizieren.

Ein Beispiel für die Authentifizierung bei Verwendung des direkten Exports von Tracedaten finden Sie unter Authentifizierung konfigurieren. In diesem Beispiel wird veranschaulicht, wie Sie den Exporter mit Ihren Google Cloud Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) konfigurieren und Ihrer Anwendung eine sprachspezifische Google Auth-Bibliothek hinzufügen.

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:

Dienstendpunkte

Ein Dienstendpunkt ist eine Basis-URL, die die Netzwerkadresse eines API-Dienstes angibt. Die Telemetry API unterstützt einen globalen Endpunkt und regionale Endpunkte:

  • Globaler Endpunkt: telemetry.googleapis.com. Nachdem Google Cloud Observability alle Validierungsschritte für diesen Endpunkt erfolgreich abgeschlossen hat, werden die Daten zur Speicherung an einen Backend-Dienst gesendet.

  • Regionale Endpunkte: telemetry.REGION.rep.googleapis.com, wobei REGION eine unterstützte Region ist. Nachdem Google Cloud Observability alle Validierungsschritte für diese Endpunkte erfolgreich abgeschlossen hat, werden die Daten an einen Backend-Dienst gesendet. Dieser Dienst speichert oder verwirft die Daten:

    • Log- und Tracedaten werden gespeichert. Der Backend-Dienst verschiebt Daten bei Bedarf automatisch zwischen Regionen.
    • Messwertdaten werden nur gespeichert, wenn das dem Standortlabel zugeordnete Label mit der Region des Endpunkts oder einer Zone in dieser Region übereinstimmt.

    Eine Liste der unterstützten regionalen Endpunkte finden Sie auf den API-Referenzseiten.

Durch die Aufnahme von Trace-Daten kann die Erstellung eines Observability-Buckets ausgelöst werden. Die Verwendung eines regionalen Endpunkts hat jedoch keinen Einfluss darauf, wo der Beobachtungs-Bucket erstellt wird. Der Standort eines Observability-Buckets wird vom System anhand von Standardeinstellungen, Organisationsrichtlinien und den unterstützten Bucket-Standorten bestimmt.