In diesem Dokument wird beschrieben, wie Sie mit der Cloud Monitoring API benutzerdefinierte Messwerte erstellen und wie Sie benutzerdefinierte Messwertdaten schreiben.
Für benutzerdefinierte Messwerte werden dieselben Elemente verwendet wie für die integrierten Cloud Monitoring-Messwerte:
- Eine Reihe von Datenpunkten.
- Informationen zum Messwerttyp, die Aufschluss darüber geben, für was die Datenpunkte stehen.
- Informationen zu überwachten Ressourcen, die Aufschluss über den Ursprung der Datenpunkte geben.
Benutzerdefinierte Messwerte werden genauso verwendet wie integrierte Messwerte. Sie können also Diagramme und Benachrichtigungen für Ihre benutzerdefinierten Messwertdaten erstellen.
Hinweis
Informationen zu den Strukturen, die allen Messwerten zugrunde liegen, finden Sie unter Messwerte, Zeitachsen und Ressourcen.
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.
Erstellen Sie einen benutzerdefinierten Messwert
Um einen benutzerdefinierten Messwert zu erstellen, definieren Sie entweder ein MetricDescriptor
-Objekt, das verschiedene Informationen zu dem Messwert angibt, oder schreiben Sie Messwertdaten. Wenn Sie Messwertdaten schreiben, wird in Monitoring der Messwertdeskriptor basierend auf der Struktur der von Ihnen bereitgestellten Daten erstellt.
Informationen zum Entwerfen eines Messwertdeskriptors finden Sie unter Messwertdeskriptoren für benutzerdefinierte Messwerte.
Messwertdeskriptoren automatisch erstellen
Falls Sie Messwertdaten schreiben, wenn noch kein Messwertdeskriptor für den benutzerdefinierten Messwert vorhanden ist, wird automatisch ein Messwertdeskriptor erstellt. Dieser neue Messwertdeskriptor entspricht jedoch vielleicht nicht Ihren Vorstellungen, da die automatische Erstellung von Messwertdeskriptoren auf verschiedenen Annahmen und Standardwerten basiert.
Cloud Monitoring erstellt ein neues MetricDescriptor
, wenn das TimeSeries
-Objekt, das in einem Aufruf von timeSeries.create
enthalten ist, auf ein Metric
-Objekt verweist, das einen nicht vorhandenen Messwerttypnamen angibt.
Cloud Monitoring verwendet die folgenden Regeln, um die MetricDescriptor
zu füllen:
type
: Der Typ wird aus dem FeldMetric
Objekttype
kopiert.name
: Der Name wird aus der Projekt-ID im Methodenaufruf und aus dem Wert vontype
im ObjektMetric
erstellt.labels
: Die Labels, die imMetric
-Objekt erscheinen. Jeder Labeldeskriptor im neuen Messwertdeskriptor enthält folgende Felder:key
: Der Labelschlüssel im ObjektMetric
.valueType
:STRING
description
: Nicht definiert
metricKind
: Die Art des Messwerts wird aufGAUGE
festgelegt, es sei denn, Sie geben den ParametermetricKind
desTimeSeries
-Objekts an. Wenn SiemetricKind
angeben, hat der neue Messwert diese Art. Sie können nur die TypenGAUGE
undCUMULATIVE
angeben.valueType
: Der Werttyp wird dem eingegebenen Wert des geschriebenenPoint
entnommen. Der Werttyp mussBOOL
,INT64
,DOUBLE
oderDISTRIBUTION
sein. Wenn Sie im FeldvalueType
desTimeSeries
einen Werttyp angeben, muss dieser mit dem Typ desPoint
übereinstimmen.unit
: Nicht definiertdescription
:"Auto created custom metric."
.displayName
: Nicht definiert
In einem einzigen timeSeries.create
-Aufruf können Sie mehrere TimeSeries
-Objekte einschließen, die auf denselben nicht vorhandenen Messwerttyp verweisen. In diesem Fall bestehen die Labels im neuen Messwertdeskriptor der Gesamtheit aller Labels in den Metric
-Objekten in allen Zeitachsen in diesem Aufruf von create
.
Nächster Schritt: Weitere Informationen finden Sie unter Daten mit benutzerdefinierten Messwerten schreiben.
Messwertdeskriptoren manuell erstellen
So erstellen Sie einen Messwertdeskriptor:
Bestimmen Sie die Struktur Ihres Messwertdeskriptors. Zur Unterstützung bei diesen Entscheidungen können Sie sich die integrierten Messwerte ansehen und ihre Zeitachsendaten ansehen:
Wählen Sie einen Messwertnamen für den benutzerdefinierten Messwert aus.
Wählen Sie einen angezeigten Namen und eine Beschreibung für den Messwert aus. Der angezeigte Name wird in der Google Cloud Console verwendet.
Wählen Sie ein Projekt oder Projekte aus, in denen Sie den benutzerdefinierten Messwert festlegen und in die seine Zeitachsendaten geschrieben werden. Wenn du denselben Messwert in mehreren Projekten benötigst, definiere in jedem Projekt identische Definitionen des Messwerts.
Zum Schreiben benutzerdefinierter Messwerte aus Ressourcen, die von einem AWS-Konto verwaltet werden, erstellen Sie den Messwertdeskriptor im AWS-Connector-Projekt für dieses Konto.
Bestimmen Sie die Art des Messwerts, den Werttyp und optional die Einheiten. Nicht alle Werttypen und Messwertarten werden für benutzerdefinierte Messwerte unterstützt. Weitere Informationen zu diesen Feldern finden Sie unter Werttypen und Messwertarten.
Wählen Sie die Labels für den Messwert aus – den Namen, den Werttyp und die Beschreibung.
Ermitteln Sie die überwachten Ressourcen, für die die Messwertdaten geschrieben werden. Wählen Sie aus der folgenden Liste aus:
aws_ec2_instance
: Amazon EC2-Instanzdataflow_job
: Dataflow-Job.gae_instance
: App Engine-Instanzgce_instance
: Compute Engine-Instanzgeneric_node
: Vom Nutzer angegebener Rechenknoten.generic_task
: Benutzerdefinierte Aufgabe.gke_container
: GKE-Containerinstanzglobal
: Verwenden Sie diese Ressource, wenn kein anderer Ressourcentyp geeignet ist. In den meisten Anwendungsfällen istgeneric_node
odergeneric_task
eine bessere Wahl alsglobal
.k8s_cluster
: Kubernetes-Cluster.k8s_container
: Kubernetes-Containerk8s_node
: Kubernetes-Knoten.k8s_pod
: Kubernetes-Pod.
Erstelle ein
MetricDescriptor
-Objekt und übergib es dann als Argument an einen Aufruf dermetricDescriptors.create
-Methode.
In der Regel ist ein Fehler beim Aufruf von metricDescriptors.create
mit demselben Typnamen wie bei einem vorhandenen Messwertdeskriptor. Wenn jedoch alle Felder des neuen MetricDescriptor
-Objekts mit den Feldern des vorhandenen Deskriptors exakt identisch sind, entsteht kein Fehler, aber der Vorgang ist wirkungslos.
Im folgenden Beispiel erstellen Sie einen benutzerdefinierten Messwert vom Typ „gauge”.
Protokoll
Verwenden Sie zum Erstellen eines Messwertdeskriptors die Methode metricDescriptors.create
.
Sie können diese Methode ausführen, indem Sie das APIs Explorer-Widget auf der Referenzseite der Methode verwenden. Weitere Informationen finden Sie unter APIs Explorer.
Im Folgenden finden Sie die Beispielparameter für metricDescriptors.create
:
- Name (URL):
projects/[PROJECT_ID]
Anfragetext: Geben Sie ein
MetricDescriptor
-Objekt an. Beispiel:{ "name": "", "description": "Daily sales records from all branch stores.", "displayName": "Sales", "type": "custom.googleapis.com/stores/sales", "metricKind": "CUMULATIVE", "valueType": "DOUBLE", "unit": "{USD}", "labels": [ { "key": "store_id", "valueType": "STRING", "description": "The ID of the store." }, ], }
Geben Sie diese Werte in die Felder des Widgets ein. Ersetzen Sie dabei [PROJECT_ID
durch Ihre Projekt-ID:
Klicken Sie auf die Schaltfläche Ausführen, um die Methode auszuführen.
Beim Erstellen eines neuen benutzerdefinierten Messwerts wird das Feld name
in MetricDescriptor
ignoriert und kann ausgelassen werden. Die Methode create
gibt den neuen Messwertdeskriptor mit einem Eintrag im Feld name
zurück. Dieser würde im gegebenen Beispiel so lauten:
"name": "projects/[PROJECT_ID]/metricDescriptors/custom.googleapis.com/stores/daily_sales"
Wenn Sie beispielsweise einen Messwertdeskriptor abrufen möchten, verwenden Sie diesen Namen.
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie den Artikel Fehlerbehebung bei API-Aufrufen.
Nächster Schritt: Weitere Informationen finden Sie unter Daten mit benutzerdefinierten Messwerten schreiben.
Benutzerdefinierte Messwerte schreiben
Daten können nur in benutzerdefinierte Messwerttypen geschrieben werden. Verwenden Sie zum Schreiben von Daten die Methode timeSeries.create
.
Wenn die Zeitachse vorhanden ist, wird mit dieser Methode ein neuer Datenpunkt an die vorhandene Zeitachse angefügt. Wenn die Zeitachse nicht vorhanden ist, wird sie mit dieser Methode erstellt und die Daten werden angehängt.
Zum Schreiben von Datenpunkten übergeben Sie eine Liste mit Objekten vom Typ TimeSeries
an die Methode timeSeries.create
.
Die Liste darf maximal 200 Objekte enthalten und jedes Objekt in der Liste muss eine andere Zeitachse angeben:
- Die Werte der Felder
metric
undresource
kennzeichnen ein bestimmtesTimeSeries
-Objekt. Diese Felder stellen den Messwerttyp der Daten und die überwachte Ressource dar, aus der die Daten erfasst wurden. - Lassen Sie die Felder
metricKind
undvalueType
weg. Sie werden beim Schreiben von Datenpunkten ignoriert. Jedes
TimeSeries
-Objekt darf nur ein einzigesPoint
-Objekt enthalten:- Der Wert und das Zeitintervall des Punkts müssen mit der Definition des Messwerttyps übereinstimmen. Informationen zu Zeitintervallen für unterschiedliche Messwertarten finden Sie unter
TimeInterval
. - Das Zeitintervall des Punkts muss nach allen bereits in der Zeitachse enthaltenen Punkten liegen.
- Das Ende des Intervalls darf maximal 25 Stunden in der Vergangenheit oder fünf Minuten in der Zukunft liegen.
- Der Wert und das Zeitintervall des Punkts müssen mit der Definition des Messwerttyps übereinstimmen. Informationen zu Zeitintervallen für unterschiedliche Messwertarten finden Sie unter
Wenn Sie mehrere Punkte in dieselbe Zeitachse schreiben möchten, verwenden Sie für jeden Punkt einen separaten Aufruf der Methode
timeSeries.create
. Schreiben Sie keine Daten in eine einzelne Zeitachse, die nicht schneller als ein Punkt alle 5 Sekunden sind. Wenn Sie Datenpunkte verschiedenen Zeitachsen hinzufügen, gibt es keine Begrenzung.
Protokoll
Verwenden Sie zum Schreiben von Messwertdaten die Methode timeSeries.create
.
Sie können diese Methode ausführen, indem Sie das APIs Explorer-Widget auf der Referenzseite der Methode verwenden. Weitere Informationen finden Sie unter APIs Explorer.
So schreiben Sie einen Punkt in den benutzerdefinierten Messwert stores/daily_sales
, der unter Manuelle Erstellung von Messwertdeskriptoren erstellt wurde:
- Rufen Sie die Referenzseite für
timeSeries.create
auf. - Geben Sie im APIs Explorer-Widget die unten aufgeführten Parameter an.
- Klicken Sie auf die Schaltfläche Ausführen.
Verwenden Sie folgende Beispielparameter:
- Name:
projects/[PROJECT_ID]
Anfragetext: Fügen Sie eine Liste mit
TimeSeries
-Objekten hinzu. Im folgenden Beispiel ist nur eine einzige Zeitachse in der Liste enthalten.{ "timeSeries": [ { "metric": { "type": "custom.googleapis.com/my_metric", "labels": { "my_label": "my_value" } }, "resource": { "type": "gce_instance", "labels": { "project_id": "[PROJECT_ID]", "instance_id": "1234567890123456789", "zone": "us-central1-f" } }, "points": [ { "interval": { "endTime": "2018-06-01T10:00:00-04:00" }, "value": { "doubleValue": 123.45 } } ] } ] }
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie den Artikel Fehlerbehebung bei API-Aufrufen.
Benutzerdefinierte Messwerte löschen
Löschen Sie den Messwertdeskriptor des benutzerdefinierten Messwerts, um diesen zu löschen. Sie können die in Ihrem Google Cloud-Projekt gespeicherten Zeitachsendaten nicht löschen. Allerdings werden durch das Löschen des Messwertdeskriptors die Daten nicht mehr zugänglich. Die Daten laufen ab und werden gemäß der Datenaufbewahrungsrichtlinie gelöscht.
Sie können den Messwertdeskriptor für einen integrierten Messwert nicht löschen.
Rufen Sie die Methode metricDescriptors.delete
auf, um den Messwertdeskriptor zu löschen.
Protokoll
Verwenden Sie zum Löschen eines Messwertdeskriptors die Methode metricDescriptors.delete
.
Sie können diese Methode ausführen, indem Sie das APIs Explorer-Widget auf der Referenzseite der Methode verwenden. Weitere Informationen finden Sie unter APIs Explorer.
So löschst du den unter Manuelle Erstellung von Messwertdeskriptoren erstellten benutzerdefinierten Messwert stores/daily_sales
:
- Rufen Sie die Referenzseite für
metricDescriptors.delete
auf: Geben Sie im APIs Explorer-Widget den Namen des Messwertdeskriptors an:
Name:
projects/[PROJECT_ID]/metricDescriptors/custom.googleapis.com/stores/daily_sales
Klicken Sie auf die Schaltfläche Ausführen.
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie den Artikel Fehlerbehebung bei API-Aufrufen.
Benutzerdefinierten Messwert ändern
Wenn Sie einen benutzerdefinierten Messwert ändern möchten, müssen Sie das MetricDescriptor
-Objekt aktualisieren, das den benutzerdefinierten Messwert definiert.
Die einzige unterstützte Änderung ist das Hinzufügen von Labels.
Wenn Sie einem vorhandenen benutzerdefinierten Messwert Labels hinzufügen möchten, verwenden Sie die Methode timeSeries.create
und nehmen Sie die neuen Labels mit den Zeitreihendaten auf. Die Labels werden dem Messwertdeskriptor hinzugefügt, wenn die Labels, die Sie schreiben möchten, gültig sind und die Gesamtzahl der Labels unter 30 liegt.
Die Zeitachsendaten werden dann so geschrieben, als wäre das Label von Anfang an vorhanden gewesen.
Wenn du mehr als neue Labels hinzufügen möchtest, musst du den Messwertdeskriptor löschen und neu erstellen. In diesem Fall gehen alle Zeitachsendaten verloren, die zuvor für den alten Messwertdeskriptor erfasst wurden. Weitere Informationen finden Sie unter Benutzerdefinierte Messwerte löschen.
Sie können einen Messwert nicht umbenennen.