OpenCensus ist ein kostenloses Open-Source-Projekt, dessen Bibliotheken:
- Anbieterneutrale Unterstützung für die Erfassung von Messwert- und Trace-Daten in mehreren Sprachen
- Die erfassten Daten können mit Exportern in verschiedene Back-End-Anwendungen exportiert werden, einschließlich Cloud Monitoring.
Obwohl Cloud Monitoring eine API bietet, die das Definieren und Erfassen benutzerdefinierter Messwerte unterstützt, ist sie eine untergeordnete API. OpenCensus bietet eine API, die dem Stil der Sprachcommunity entspricht, sowie einen Exporter, der Ihre Messwertdaten über die Monitoring API an Cloud Monitoring sendet.
OpenCensus bietet außerdem eine gute Unterstützung für Anwendungs-Tracing. Einen allgemeinen Überblick finden Sie unter OpenCensus Tracing. Cloud Trace empfiehlt OpenCensus für die Trace-Instrumentierung. Wenn Sie sowohl Messwert- als auch Trace-Daten von Ihren Diensten erfassen möchten, können Sie eine einzige Verteilung von Bibliotheken verwenden. Weitere Informationen zum Verwenden von OpenCensus mit Cloud Trace finden Sie unter Clientbibliotheken für Trace.
Hinweis
Um Cloud Monitoring verwenden zu können, muss ein Cloud-Projekt mit aktivierter Abrechnungsfunktion vorhanden sein. Folgende Schritte sind erforderlich:
-
Wählen Sie in der Google Cloud Console auf der Seite der Projektauswahl ein Google Cloud-Projekt aus oder erstellen Sie eines.
-
Die Abrechnung für das Cloud-Projekt muss aktiviert sein. So prüfen Sie, ob die Abrechnung für ein Projekt aktiviert ist.
- Prüfen Sie, ob die Monitoring API aktiviert ist. Weitere Informationen finden Sie unter Monitoring-API aktivieren.
Bei Anwendungen, die außerhalb von Google Cloud ausgeführt werden, muss die Anwendung von Ihrem Cloud-Projekt authentifiziert werden. In der Regel können Sie die Authentifizierung konfigurieren, indem Sie für Ihr Projekt ein Dienstkonto erstellen und eine Umgebungsvariable konfigurieren.
Erstellen Sie für Anwendungen, die Sie in einer Amazon Elastic Compute Cloud-Instanz (Amazon EC2) ausführen, das Dienstkonto für das AWS-Connector-Projekt der Instanz.
Informationen zum Erstellen eines Dienstkontos finden Sie unter Erste Schritte bei der Authentifizierung.
OpenCensus installieren
Damit Sie von OpenCensus erfasste Messwerte in Ihrem Google Cloud-Projekt verwenden können, müssen Sie die OpenCensus-Messwertbibliotheken und den Stackdriver-Exporter für Ihre Anwendung verfügbar machen. Der Stackdriver-Exporter exportiert die Messwerte, die OpenCensus erfasst, in Ihr Google Cloud-Projekt. Sie können diese Messwerte dann mit Cloud Monitoring grafisch darstellen oder überwachen.
Go
Für die Verwendung von OpenCensus ist Go in der Version 1.11 oder höher erforderlich. Die Abhängigkeiten werden automatisch für Sie gehandhabt.
Java
Füge für Maven das Element
dependencies
in der Datei pom.xml
hinzu:
Node.js
- Bevor Sie den OpenCensus-Kern und die Exporter-Bibliotheken installieren, müssen Sie Ihre Umgebung auf die Node.js-Entwicklung vorbereitet haben.
- Am einfachsten lässt sich OpenCensus mit npm installieren:
npm install @opencensus/core npm install @opencensus/exporter-stackdriver
- Platzieren Sie die unten aufgeführten
require
-Anweisungen am Anfang des Hauptskripts oder des Einstiegspunkts Ihrer Anwendung vor jedem anderen Code:
Python
Installieren Sie die OpenCensus-Core-Bibliothek und die Stackdriver-Exporter-Bibliothek mithilfe des folgenden Befehls:
pip install -r opencensus/requirements.txt
Die Datei requirements.txt
befindet sich im GitHub-Repository für diese Beispiele (python-docs-samples).
Benutzerdefinierte Messwerte mit OpenCensus schreiben
Der Code zur Verwendung von OpenCensus für Messwerte umfasst die folgenden drei Schritte:
- Importieren Sie die OpenCensus-Statistiken und die OpenCensus Stackdriver-Exportpakete.
- Initialisieren Sie den Stackdriver-Exporter.
- Verwenden Sie die OpenCensus-API zur Instrumentierung Ihres Codes.
Das folgende Beispiel ist ein minimales Programm, das Messwertdaten mit OpenCensus schreibt. Das Programm führt eine Schleife aus, die Latenzmaßnahmen erfasst, und wenn die Schleife abgeschlossen ist, die Statistiken nach Cloud Monitoring und Exit exportiert werden:
Go
Java
Node.js
Python
Das Programm erstellt eine OpenCensus-Ansicht mit dem Namen task_latency_distribution
. Dieser String wird in den Namen des Messwerts aufgenommen, wenn er in Cloud Monitoring exportiert wird. Unter Messwertdeskriptoren abrufen erfahren Sie, wie die OpenCensus-Ansicht als Cloud Monitoring-Messwertdeskriptor implementiert wird.
Sie können daher den Ansichtsnamen als Suchstring verwenden, wenn Sie einen Messwert für ein Diagramm auswählen.
- Rufen Sie in der Google Cloud Console unter „Monitoring“ die Seite „Metrics Explorer” auf.
- Wählen Sie in der Symbolleiste den Tab Explorer aus.
- Wählen Sie den Tab Konfiguration aus.
- Maximieren Sie das Menü Messwert auswählen, geben Sie
OpenCensus/task_latency_distribution
in die Filterleiste ein und wählen Sie dann über die Untermenüs einen bestimmten Ressourcentyp und Messwert aus:- Wählen Sie im Menü Aktive Ressourcen die überwachte Ressource aus. Wenn Sie das Programm in einer lokalen Umgebung ausführen, wählen Sie Global aus.
- Wählen Sie im Menü Aktive Messwertkategorien die Option Benutzerdefiniert aus.
- Wählen Sie im Menü Aktive Messwerte die Option Aufgabenlatenzverteilung aus.
- Klicken Sie auf Anwenden.
- Optional: Konfigurieren Sie die Daten, fügen Sie Filter hinzu und verwenden Sie die Menüs Gruppieren nach, Aggregator und Diagrammtyp. Maximieren Sie für dieses Diagramm das Menü Liniendiagramm und wählen Sie dann Heatmap-Diagramm aus. Weitere Informationen finden Sie unter Messwerte bei der Verwendung von Metrics Explorer auswählen.
- Optional: Ändern Sie die Diagrammeinstellungen:
- Legen Sie für Kontingente und andere Messwerte, die eine Stichprobe pro Tag melden, den Zeitraum auf mindestens eine Woche fest und geben Sie als Darstellungstyp Übereinander angeordnetes Balkendiagramm an.
- Stellen Sie für Verteilungsmesswerte die Darstellung auf Heatmap-Diagramm ein.
Im folgenden Screenshot sehen Sie die Zeitachsen, die nach der Ausführung des Programms in einer lokalen Umgebung erfasst wurden:
Jede Säule in der Heatmap repräsentiert einen einzelnen Programmdurchlauf. Die farbigen Komponenten jeder Säule stehen für Buckets in der Latenzverteilung.
OpenCensus-Messwerte in Cloud Monitoring lesen
Sie verwenden benutzerdefinierte Messwerte, darunter auch von OpenCensus geschriebene Messwerte, wie integrierte Messwerte. Sie können sie grafisch darstellen, Benachrichtigungen dafür einrichten, sie lesen und sie anderweitig überwachen.
In diesem Abschnitt wird beschrieben, wie Sie mit APIs Explorer Messwertdaten lesen. Informationen zum Lesen von Messwertdaten mit der Cloud Monitoring API oder Clientbibliotheken finden Sie in den folgenden Dokumenten:
- Unter Browsermesswerte erfahren Sie, wie Sie Ihre benutzerdefinierten und integrierten Messwerte auflisten und prüfen.
- Unter Lesemesswerte erfahren Sie, wie Sie mithilfe der Monitoring API Zeitachsendaten aus benutzerdefinierten und integrierten Messwerten abrufen.
Der Screenshot im vorherigen Abschnitt stammt beispielsweise aus Metrics Explorer. Bei der Verwendung von Diagrammtools empfehlen wir den Namen der OpenCensus-Ansicht, um die Liste der Messwerte zu filtern. Weitere Informationen finden Sie unter Messwerte mit Metrics Explorer auswählen.
Messwertdeskriptoren abrufen
Zum Abrufen der Messwertdaten über die Monitoring API benötigen Sie die Cloud Monitoring-Namen, in die die OpenCensus-Messwerte exportiert wurden. Sie können diese Namen ermitteln, indem Sie die Messwertdeskriptoren abrufen, die der Exporter erstellt, und dann das Feld type
ansehen. Weitere Informationen zu Messwertdeskriptoren finden Sie unter MetricDescriptor
.
So rufen Sie die Beschreibungen der Messwerte auf, die für die exportierten Messwerte erstellt wurden:
- Rufen Sie die Referenzseite
metricDescriptors.list
auf. Füllen Sie im Widget API testen die folgenden Felder aus:
Geben Sie den Namen Ihres Projekts in das Feld
name
ein. Verwenden Sie die folgende Namensstruktur:projects/PROJECT_ID
. In diesem Dokument wird ein Projekt mit der IDa-gcp-project
verwendet.Geben Sie einen Filter in das Feld
filter
ein. In einem Projekt gibt es viele Messwertdeskriptoren. Mit Filtern können Sie solche Beschreibungen entfernen, die nicht von Interesse sind.Weil der Name der OpenCensus-Ansicht beispielsweise Teil des Messwertnamens wird, können Sie einen Filter wie diesen hinzufügen:
metric.type=has_substring("task_latency_distribution")
Der Schlüssel
metric.type
ist ein Feld in einem Typ, der in eine Zeitachse eingebettet ist. Weitere Informationen finden Sie unterTimeSeries
.Klicken Sie auf Ausführen.
Hier sehen Sie den zurückgegebenen Messwertdeskriptor:
{ "metricDescriptors": [ { "name": "projects/a-gcp-project/metricDescriptors/custom.googleapis.com/opencensus/task_latency_distribution", "labels": [ { "key": "opencensus_task", "description": "Opencensus task identifier" } ], "metricKind": "CUMULATIVE", "valueType": "DISTRIBUTION", "unit": "ms", "description": "The distribution of the task latencies", "displayName": "OpenCensus/task_latency_distribution", "type": "custom.googleapis.com/opencensus/task_latency_distribution" } ] }
Diese Zeile im Messwertdeskriptor gibt den Namen des Messwerttyps in Cloud Monitoring an:
"type": "custom.googleapis.com/opencensus/task_latency_distribution"
Sie haben jetzt die Informationen, die Sie zum Abrufen der mit dem Messwerttyp verknüpften Daten manuell benötigen. Der Wert des Feldes type
wird auch in der Google Cloud Console angezeigt, wenn Sie den Messwert als Diagramm darstellen.
Messdaten abrufen
So rufen Sie Zeitachsendaten manuell aus einem Messwerttyp ab:
- Rufen Sie die Referenzseite für
timeSeries.list
auf. Füllen Sie im Widget API testen die folgenden Felder aus:
- Geben Sie den Namen Ihres Projekts in das Feld
name
ein. Verwenden Sie die folgende Namensstruktur:projects/PROJECT_ID
. Geben Sie im Feld
filter
den folgenden Wert ein:metric.type="custom.googleapis.com/opencensus/task_latency_distribution"
Geben Sie Werte für die Felder
interval.startTime
undinterval.endTime
ein. Diese Werte müssen als Zeitstempel eingegeben werden, z. B.2018-10-11T15:48:38-04:00
. Achten Sie darauf, dass derstartTime
-Wert vor demendTime
-Wert liegt.Klicken Sie auf die Schaltfläche Ausführen.
- Geben Sie den Namen Ihres Projekts in das Feld
Hier sehen Sie das Ergebnis eines solchen Abrufs:
{ "timeSeries": [ { "metric": { "labels": { "opencensus_task": "java-3424@docbuild" }, "type": "custom.googleapis.com/opencensus/task_latency_distribution" }, "resource": { "type": "gce_instance", "labels": { "instance_id": "2455918024984027105", "zone": "us-east1-b", "project_id": "a-gcp-project" } }, "metricKind": "CUMULATIVE", "valueType": "DISTRIBUTION", "points": [ { "interval": { "startTime": "2019-04-04T17:49:34.163Z", "endTime": "2019-04-04T17:50:42.917Z" }, "value": { "distributionValue": { "count": "100", "mean": 2610.11, "sumOfSquaredDeviation": 206029821.78999996, "bucketOptions": { "explicitBuckets": { "bounds": [ 0, 100, 200, 400, 1000, 2000, 4000 ] } }, "bucketCounts": [ "0", "0", "1", "6", "13", "15", "44", "21" ] } } } ] }, [ ... data from additional program runs deleted ...] ] }
Die zurückgegebenen Messwerte umfassen Folgendes:
- Informationen zu der überwachten Ressource, aus der die Daten erfasst wurden
OpenCensus erkennt automatisch überwachte
gce_instance
-,k8s_container
- undaws_ec2_instance
-Ressourcen. Diese Daten stammen aus einem Programm, das auf einer Compute Engine-Instanz ausgeführt wurde. Weitere Informationen zur Verwendung anderer überwachter Ressourcen finden Sie unter Set monitored resource for exporter (Überwachte Ressource für Exporter festlegen). - Die Beschreibung der Art des Messwerts und des Typs der Werte.
- Die tatsächlichen Datenpunkte, die innerhalb des angeforderten Zeitintervalls erfasst wurden.
Darstellung von OpenCensus-Messwerten in Monitoring
Die benutzerdefinierte Verwendung der Cloud Monitoring API für benutzerdefinierte Messwerte wird direkt unterstützt. Weitere Informationen finden Sie unter Benutzerdefinierte Messwerte mit der API erstellen. Der OpenCensus-Exporter für Cloud Monitoring verwendet diese API. Dieser Abschnitt enthält einige Informationen dazu, wie Cloud Monitoring die von OpenCensus geschriebenen Messwerte darstellt.
Die von der OpenCensus API verwendeten Konstrukte unterscheiden sich von den Konstrukten, die in Cloud Monitoring verwendet werden, ebenso wie einige der Terminologie. Wenn Cloud Monitoring auf "Messwerte" verweist, bezieht sich OpenCensus teilweise auf "Statistiken". Die Komponente von OpenCensus, die Messwertdaten an Cloud Monitoring sendet, wird beispielsweise als "stats exporter for Stackdriver" ("Exporteur von Statistiken für Stackdriver") bezeichnet.
Eine Übersicht über das OpenCensus-Modell für Messwerte finden Sie unter OpenCensus-Messwerte.
Die Datenmodelle für OpenCensus-Werte und Cloud Monitoring-Messwerte entsprechen einander nicht genau. Viele Konzepte existieren in beiden, aber sie sind nicht direkt austauschbar.
Eine OpenCensus-Ansicht entspricht dem
MetricDescriptor
in der Monitoring API. Eine Ansicht beschreibt, wie einzelne Messwerte erfasst und zusammengefasst werden. Tags sind in allen erfassten Messungen enthalten.Ein OpenCensus-Tag ("tag") ist ein Schlüssel/Wert-Paar. Ein OpenCensus-Tag entspricht im Allgemeinen dem
LabelDescriptor
in der Monitoring API. Mit Tags können Sie kontextbezogene Informationen erfassen, die Sie zum Filtern und Gruppieren von Messwerten verwenden können.Eine OpenCensus-Kennzahl ("measure") beschreibt die aufzuzeichnenden Messwertdaten. Eine OpenCensus-Zusammenfassung ("aggregation") ist eine Funktion, die auf Daten angewendet wird, um sie zu aggregieren. Diese Funktionen werden beim Export verwendet, um die
MetricKind
-,ValueType
- und Einheiten zu ermitteln, die im Cloud Monitoring-Messwertdeskriptor angegeben sind.Ein OpenCensus-Messwert ist ein erfasster Datenpunkt. Messwerte müssen in Ansichten zusammengefasst werden. Andernfalls werden die einzelnen Messwerte gelöscht. Eine OpenCensus-Messung ist ähnlich wie eine
Point
in der Monitoring API. Wenn Messwerte in Ansichten zusammengefasst werden, werden die aggregierten Daten als Ansichtsdaten gespeichert, analog zu einerTimeSeries
in der Monitoring API.
Weitere Informationen
OpenCensus stellt eine verbindliche Referenzdokumentation für die Messwert-API und den Stackdriver-Exporter zur Verfügung. Die folgende Tabelle enthält Links zu diesen Referenzdokumenten:
Sprache API-Referenzdokumentation Exporter-Dokumentation Kurzanleitung Go Go API Statistiken- und Trace-Exporter Messwerte Java Java API Statistiken-Exporter Messwerte NodeJS NodeJS API Statistiken-Exporter Messwerte Python Python API Statistiken-Exporter Messwerte