API-Übersicht

Auf dieser Seite finden Sie einen kurzen Überblick über die Observability API und die Telemetry API (OTLP).

Informationen zur Observability API

Mit der Observability API haben Sie folgende Möglichkeiten:

  • Standardeinstellungen für Observability-Buckets für Projekte, Ordner und Organisationen konfigurieren. Mit diesen Einstellungen können Sie Compliance-Anforderungen und regulatorische Vorgaben erfüllen. Sie können Folgendes konfigurieren:

    • Ein Standardspeicherort für neue Observability-Buckets.
    • Für jeden Standort ein standardmäßiger Cloud Key Management Service-Schlüssel. Mit diesem Schlüssel werden neue Observability-Buckets verschlüsselt.

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

  • Beobachtbarkeitsbereich 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 Beobachtbarkeitsbereiche konfigurieren.

  • Listen Sie Informationen zu den Observability-Buckets in Ihrem Google Cloud -Projekt auf. Ihre Trace-Daten werden in einem Beobachtungs-Bucket gespeichert. Informationen zum Datenmodell finden Sie unter Speicher – Übersicht.

  • Erstellen Sie eine Verknüpfung für ein Dataset, damit BigQuery Lesezugriff auf das Dataset hat. 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 Parameter „path“ durch den Platzhalter (-) 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 einen Platzhalter enthalten oder wenn sich der Standort von der Region des Endpunkts unterscheidet.

API-Referenz

Informationen zur Telemetry API

Die Telemetry API (OTLP) 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 OTLP-formatierte Logdatensätze in Ihr Projekt aufnehmen. Weitere Informationen finden Sie unter OTLP-Logs in die Telemetry API schreiben.

  • Messwerte: Mit der Telemetry API können Sie Messwerte im OTLP-Format mithilfe des otlphttp-Exporters und eines OpenTelemetry Collectors oder eines OpenTelemetry SDK in Cloud Monitoring aufnehmen. Weitere Informationen finden Sie unter Übersicht über die Aufnahme von OTLP-Messwerten.

  • Traces: Mit der Telemetry API können Sie OTLP-formatierte Trace-Daten 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 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.

API-Referenz

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