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 Beobachtbarkeits-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 Beobachtbarkeits-Buckets.
    • Für jeden Standort einen Standardschlüssel für den Cloud Key Management Service. Dieser Schlüssel wird zum Verschlüsseln neuer Beobachtbarkeits-Buckets verwendet.

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

  • Den 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.

  • Informationen zu den Beobachtbarkeits-Buckets in Ihrem Google Cloud Projekt auflisten. Ihre Tracedaten werden in einem Beobachtbarkeits-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.

Unterstützung durch VPC Service Controls

Der Observability API-Dienst mit dem Dienstnamen observability.googleapis.com wird von VPC Service Controls unterstützt. Weitere Informationen finden Sie unter:

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 Pfad-Parameter 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 OTLP-formatierte Logeinträge in Ihr Projekt aufnehmen. Weitere Informationen finden Sie unter OTLP-Aufnahme – Übersicht.

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

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

Unterstützung durch VPC Service Controls

Der Telemetry API-Dienst mit dem Dienstnamen telemetry.googleapis.com wird von VPC Service Controls unterstützt. 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, die Log-, Messwert- oder Tracedaten aufnehmen können. Weitere Informationen zu VPC Service Controls finden Sie unter:

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 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 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 Beobachtbarkeits-Buckets ausgelöst werden. Die Verwendung eines regionalen Endpunkts hat jedoch keinen Einfluss darauf, wo das System das Beobachtbarkeits-Bucket erstellt. Der Standort eines Beobachtbarkeits-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: