Auf dieser Seite werden Sie durch die folgenden Schritte geführt:
- Installieren Sie die OpenTelemetry-Pakete.
- Anwendung für den Export von Spans nach Cloud Trace konfigurieren
- Konfigurieren Sie Ihre Plattform.
Releaseinformationen finden Sie hier:
Referenzinhalte zu OpenTelemetry finden Sie hier:
Aktuelle Informationen zu OpenTelemetry für C++ sowie weitere Dokumentation und Beispiele finden Sie unter OpenTelemetry.
Hinweise
Aktivieren Sie die erforderliche API.
OpenTelemetry-Pakete installieren
- Richten Sie eine C++-Entwicklungsumgebung ein.
- Installieren Sie die OpenTelemetry-Exporter-Bibliothek für Google Cloud C++. Informationen zur Installation finden Sie in der Kurzanleitung zu OpenTelemetry.
Export von Spans nach Cloud Trace konfigurieren
Rufen Sie zum Konfigurieren des Exports von Trace-Daten die Methode google::cloud::otel::ConfigureBasicTracing(...)
in der Methode main()
auf:
Das Feld project_id
ist das Google Cloud-Projekt, in dem Sie die Traces speichern möchten.
Die Methode ConfigureBasicTracing(...)
instanziiert ein TracerProvider
-Objekt, das einen Cloud Trace-Exporter implementiert. Wenn das vom Aufruf von ConfigureBasicTracing(...)
zurückgegebene Objekt außerhalb des Bereichs liegt, wird das vorherige TracerProvider
-Objekt wiederhergestellt, sofern vorhanden.
Abtastrate konfigurieren
Anwendungen können große Mengen an Trace-Daten generieren. Das folgende Beispiel zeigt, wie die Abtastrate konfiguriert wird:
Mit einer benutzerdefinierten TracerProvider
in Cloud Trace exportieren
Möglicherweise gibt es Anwendungsfälle, die ein benutzerdefiniertes TracerProvider
-Objekt erfordern. Wenn Sie beispielsweise mehrere Exporter gleichzeitig verwenden möchten, müssen Sie ein benutzerdefiniertes TracerProvider
-Objekt erstellen. In diesen Fällen können Sie den Cloud Trace-Exporter direkt verwenden:
Eigene Anwendung instrumentieren
Wie Sie Ihre Anwendung für die Erfassung von Trace-Spans konfigurieren, erfahren Sie unter OpenTelemetry-Tracing. Auf dieser Seite wird beschrieben, wie Sie die folgenden Schritte ausführen:
- Span erstellen
- Verschachtelte Spans erstellen
- Span-Attribute festlegen
- Spans mit Ereignissen erstellen
- Spans mit Links erstellen
Beispielanwendung
Eine Beispielanwendung finden Sie in der quickstart.
Plattform konfigurieren
Sie können Cloud Trace in Google Cloud und auf anderen Plattformen verwenden.
In Google Cloud ausführen
Wenn Ihre Anwendung in Google Cloud ausgeführt wird, müssen Sie für die Clientbibliothek keine Anmeldedaten zur Authentifizierung in der Clientbibliothek angeben. Sie müssen jedoch darauf achten, dass auf Ihrer Google Cloud Platform der Zugriffsbereich der Cloud Trace API aktiviert ist.
Eine Liste der unterstützten Google Cloud-Umgebungen finden Sie unter Umgebungsunterstützung.
Für die folgenden Konfigurationen wird die Cloud Trace API über die Standardeinstellungen für den Zugriffsbereich aktiviert:
- Flexible App Engine-Umgebung
App Engine-Standardumgebung
Google Kubernetes Engine (GKE)
Compute Engine
Cloud Run
Wenn Sie benutzerdefinierte Zugriffsbereiche verwenden, muss der Zugriffsbereich der Cloud Trace API aktiviert sein:
Informationen zum Konfigurieren der Zugriffsbereiche für Ihre Umgebung mit der Google Cloud Console finden Sie unter Google Cloud-Projekt konfigurieren.
Geben Sie für
gcloud
-Nutzer mithilfe des Flags--scopes
Zugriffsbereiche an und beziehen Sie den Zugriffsbereich der Cloud Trace APItrace.append
ein. So erstellen Sie beispielsweise einen GKE-Cluster, für den nur die Cloud Trace API aktiviert ist:gcloud container clusters create example-cluster-name --scopes=https://www.googleapis.com/auth/trace.append
Lokal und extern ausführen
Wenn Ihre Anwendung außerhalb von Google Cloud ausgeführt wird, müssen Sie Anmeldedaten zur Authentifizierung in Form eines Dienstkontos für die Clientbibliothek angeben. Das Dienstkonto muss die Rolle "Cloud Trace-Agent" enthalten. Informationen dazu finden Sie unter Dienstkonto erstellen.
Google Cloud-Clientbibliotheken verwenden Standardanmeldedaten für Anwendungen für die Suche nach den Anmeldedaten Ihrer Anwendung.
Sie haben drei Möglichkeiten, diese Anmeldedaten anzugeben:
Führen Sie
gcloud auth application-default login
ausPlatzieren Sie das Dienstkonto in einem Standardpfad für Ihr Betriebssystem. Im Folgenden sind die Standardpfade für Windows und Linux aufgeführt:
Windows:
%APPDATA%/gcloud/application_default_credentials.json
Linux:
$HOME/.config/gcloud/application_default_credentials.json
Legen Sie die Umgebungsvariable
GOOGLE_APPLICATION_CREDENTIALS
auf den Pfad zu Ihrem Dienstkonto fest:
Linux/macOS
export GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
Windows
set GOOGLE_APPLICATION_CREDENTIALS=path-to-your-service-accounts-private-key
PowerShell:
$env:GOOGLE_APPLICATION_CREDENTIALS="path-to-your-service-accounts-private-key"
Traces ansehen
Rufen Sie in der Google Cloud Console die Seite Trace Explorer auf:
Sie können diese Seite auch über die Suchleiste finden.
Fehlerbehebung
Informationen zur Fehlerbehebung bei Cloud Trace finden Sie auf der Seite Fehlerbehebung.
Informationen zum Debuggen des C++ Cloud Trace-Exporters finden Sie im Abschnitt Fehlerbehebung der Referenzdokumentation.
Ressourcen
- https://opentelemetry.io/
- GitHub-Repository open-telemetry/opentelemetry-cpp
- google-cloud-cpp OpenTelemetry Exporters Library im GitHub-Repository.