API-Übersicht

Auf dieser Seite finden Sie eine kurze Übersicht über die Observability API und die Telemetry (OTLP) API.

Observability API

Mit der Observability API können Sie Folgendes tun:

  • Standardeinstellungen für Observability-Buckets für Projekte, Ordner und Organisationen konfigurieren. Diese Einstellungen helfen Ihnen, Ihre Compliance- und gesetzlichen Anforderungen zu erfüllen. Sie können Folgendes konfigurieren:

    • Einen Standardspeicherort für neue Observability-Buckets.
    • Für jeden Standort einen Standardschlüssel für den Cloud Key Management Service. Dieser Schlüssel wird zum Verschlüsseln neuer Observability-Buckets verwendet.

    Weitere Informationen finden Sie unter Standardeinstellungen für Observability-Buckets festlegen.

  • Den Observability-Bereich für Ihr Projekt konfigurieren. Mit diesem Bereich wird festgelegt, in welchen Ressourcen auf den Explorer-Seiten nach Log-, Messwert- und Tracedaten gesucht wird. Weitere Informationen finden Sie unter Observability-Bereiche konfigurieren.

  • Informationen zu den Observability-Buckets in Ihrem Google Cloud Projekt auflisten. Ihre Tracedaten werden in einem Observability-Bucket gespeichert. Informationen zum Datenmodell finden Sie unter Speicherübersicht.

  • Einen Link zu einem Dataset erstellen, mit dem BigQuery Lesezugriff auf das Dataset erhält. Informationen zum Erstellen eines verknüpften Datasets finden Sie unter Speicher verwalten.

Dienstendpunkte

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

  • Globaler Endpunkt: observability.googleapis.com.

    Sie können den globalen Dienstendpunkt verwenden, um alle von der Observability API unterstützten Vorgänge auszuführen. Außerdem können Sie für diesen Endpunkt mit dem Befehl list observability buckets das Feld „location“ im Pfadparameter durch das Platzhalterzeichen (-) ersetzen.

  • Regionale Endpunkte: observability.REGION.rep.googleapis.com, wobei REGION eine unterstützte Region ist. Eine Liste der Endpunkte finden Sie unter Regionaler Dienstendpunkt.

    Sie können einen regionalen Dienstendpunkt nur verwenden, wenn der im Pfadparameter angegebene Standort mit der Region des Endpunkts übereinstimmt. Befehle, die an diese Dienstendpunkte gesendet werden, schlagen fehl, wenn sie ein Platzhalterzeichen enthalten oder wenn sich der Standort von der Region des Endpunkts unterscheidet.

API-Referenz

Telemetry API

Die Telemetry (OTLP) API ist eine Implementierung des OpenTelemetry OTLP-Protokolls. Die Telemetry API bietet Kompatibilität und Unterstützung für das Open-Source-OpenTelemetry-Ökosystem:

  • Logs: Mit der Telemetry API können Sie Logeinträge im OTLP-Format in Ihr Projekt aufnehmen. Weitere Informationen finden Sie unter Übersicht zur OTLP-Aufnahme.

  • Messwerte: Mit der Telemetry API können Sie Messwerte im OTLP-Format in Cloud Monitoring aufnehmen. Verwenden Sie dazu den otlphttp Exporter und einen OpenTelemetry Collector oder ein OpenTelemetry SDK. Weitere Informationen finden Sie unter Übersicht zur OTLP-Aufnahme.

  • Traces: Mit der Telemetry API können Sie Tracedaten im OTLP-Format an Ihr Projekt senden. Außerdem sind die Trace-Limits für die Telemetry API oft großzügiger als die Limits für die Cloud Trace API.

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 erfolgreich abgeschlossen hat, werden die Daten für diesen Endpunkt an einen Backend-Dienst zur Speicherung gesendet.

  • Regionale Endpunkte: telemetry.REGION.rep.googleapis.com, wobei REGION eine unterstützte Region ist. Nachdem Google Cloud Observability alle Validierungsschritte erfolgreich abgeschlossen hat, werden die Daten für diese Endpunkte an einen Back-End-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 mit den Daten verknüpfte Standortlabel 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 Tracedaten kann die Erstellung eines Observability-Buckets ausgelöst werden. Die Verwendung eines regionalen Endpunkts hat jedoch keine Auswirkungen darauf, wo das System den Observability-Bucket erstellt. Der Standort eines Observability-Buckets wird anhand von Standardeinstellungen, Organisationsrichtlinien und den unterstützten Bucket-Standorten bestimmt.

API-Referenz

Weitere Informationen zur Telemetry API finden Sie in den folgenden Dokumenten: