In diesem Dokument wird erläutert, wie Sie mit der Cloud Monitoring API Listen oder Beschreibungen der folgenden Elemente abrufen:
- Benutzerdefinierte Messwerttypen, die in Ihrem Projekt definiert sind.
- Messwerttypen von Drittanbietern mit Zeitachsendaten in Ihrem Projekt.
Von BindPlane generierte Messwerte sind Beispiele für Messwerte von Drittanbietern. BindPlane-Messwerte haben das Präfix
workload.googleapis.com/3rd-party-app-name/
. Eine vollständige Liste der unterstützten Messwerte für Drittanbieter-Anwendungen finden Sie in der Dokumentation zu BindPlane-Quellen. - Von Google Cloud bereitgestellte integrierte Messwerttypen. Mithilfe dieser Messwerttypen können Sie benutzerdefinierte Messwerte erstellen. Informationen zu diesen Messwerten finden Sie auch in der Dokumentation (siehe Messwertliste).
- Überwachte Ressourcentypen für Ihr Projekt. Informationen zu diesen Ressourcen finden Sie in der Dokumentation. Siehe Liste der überwachten Ressourcen.
Sie können die Methoden ausführen, ohne Code schreiben zu müssen. In den Beispielen auf den Tabs Protokoll auf dieser Seite wird der formularbasierte APIs Explorer verwendet. Weitere Informationen zu diesem Tool finden Sie unter APIs Explorer.
An den Beispielen mit ausführbarem Code auf dieser Seite können Sie sehen, wie die Methoden in bestimmten Programmiersprachen aufgerufen werden.
Hinweise
- Eine Einführung in Messwerte und überwachte Ressourcen finden Sie unter Messwerte, Zeitachsen und Ressourcen.
Messwertdeskriptoren auflisten
Messwertdeskriptoren sind die Schemas, die Messwerte definieren. Details zu den gewünschten Messwerten finden Sie in den verfügbaren -Messwertdeskriptoren:
- Integrierte Messwerte: Sie können API-Anfragen an jedes vorhandene Projekt senden oder die Dokumentation zu Messwertlisten verwenden.
- Benutzerdefinierte und externe Messwerte: Die API-Anfrage muss an ein Projekt gesendet werden, in dem der benutzerdefinierte Messwert definiert ist oder Zeitreihendaten für den Messwert vorhanden sind.
Weitere Informationen zur Benennung von Messwerttypen finden Sie unter Namenskonventionen.
Messwerttypen auflisten
Eine aktuelle Liste der Messwertdeskriptoren erhalten Sie mit der Methode metricDescriptors.list
.
Verwenden Sie einen Filter, um die zurückgegebenen Messwerttypen einzugrenzen.
Hilfe bei der Entscheidung, nach welchen Messwerttypen gesucht werden soll, finden Sie unter Werttypen und Messwertarten.
Protokoll
Öffnen Sie die Referenzseite für
metricDescriptors.list
.Geben Sie im Bereich Testen Sie diese Methode Folgendes ein:
- Name:
projects/PROJECT_ID
. Ersetzen SiePROJECT_ID
durch die ID Ihres Google Cloud-Projekts. - Filter:
metric.type = starts_with("compute.googleapis.com")
- Name:
Klicken Sie auf Execute.
Das folgende Antwortbeispiel enthält einige der abgerufenen Messwertdeskriptoren:
"metricDescriptors": [ { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_bytes_count", "labels": [{...}], ... "description": "Count of incoming bytes dropped by the firewall.", "displayName": "Dropped bytes", "type": "compute.googleapis.com/firewall/dropped_bytes_count", ... }, { "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [{...}], ... "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }, ... ]
Der Wert type
in jedem Deskriptor identifiziert den Messwertdeskriptor, z. B. compute.googleapis.com/firewall/dropped_packets_count
. Dieser Wert wird manchmal auch als "Messwerttyp" oder "Messwerttypname" bezeichnet.
Wenn Sie die Anfrage als curl
-Befehl, HTTP-Anfrage oder in JavaScript ansehen möchten, klicken Sie in APIs Explorer auf fullscreen Vollbild.
C#
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Go
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
PHP
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Messwertdeskriptoren abrufen
Verwenden Sie die Methode metricDescriptors.get
, um Informationen zu einem einzelnen Messwerttyp abzurufen.
Diese Methode gibt einen Messwertdeskriptor zurück.
Um einen bestimmten Messwertdeskriptor abzurufen, müssen Sie der API den vollständigen Namen des Messwerts angeben. Der vollständige Name besteht aus zwei Komponenten:
- Ein Präfix bestehend aus
projects/PROJECT_ID/metricDescriptors
. - Der Wert
type
, der den Messwertdeskriptor angibt, z. B.compute.googleapis.com/firewall/dropped_packets_count
. Weitere Informationen zum Werttype
finden Sie auf dem Tab Protokoll in Messwerttypen auflisten.
Im Folgenden finden Sie ein Beispiel für den vollständigen Namen eines Messwerts:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Protokoll
So rufen Sie den Deskriptor für den Compute Engine-Messwert /firewall/dropped_packets_count
ab:
Öffnen Sie die Referenzseite für
metricDescriptors.list
.Geben Sie im Bereich Testen Sie diese Methode Folgendes ein:
Name:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Ersetzen Sie
PROJECT_ID
durch die ID Ihres Google Cloud-Projekts.
Klicken Sie auf Execute.
Das folgende Antwortbeispiel enthält den Deskriptor des Messwerts:
{ "name": "projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count", "labels": [ { "key": "instance_name", "description": "The name of the VM instance." } ], "metricKind": "DELTA", "valueType": "INT64", "unit": "1", "description": "Count of incoming packets dropped by the firewall.", "displayName": "Dropped packets", "type": "compute.googleapis.com/firewall/dropped_packets_count", }
Wenn Sie die Anfrage als curl
-Befehl, HTTP-Anfrage oder in JavaScript ansehen möchten, klicken Sie in APIs Explorer auf fullscreen Vollbild.
C#
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Go
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
PHP
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Überwachte Ressourcen auflisten
Überwachte Ressourcen sind überwachbare Cloudentitäten. Suchen Sie in der Liste der überwachten Ressourcentypen, um Arten von Entitäten mit Messwerten zu finden.
Um Informationen zu überwachten Ressourcen abzurufen, können Sie API-Anfragen an ein vorhandenes Projekt senden oder die Dokumentation zur Liste überwachter Ressourcen verwenden.
Ressourcentypen auflisten
Um eine aktuelle Liste der überwachten Ressourcentypen von der Monitoring API abzurufen, verwenden Sie die Methode monitoredResourceDescriptors.list
, und geben Sie Ihre Projekt-ID an.
Protokoll
Öffnen Sie die Referenzseite von
monitoredResourceDescriptors.list
.Geben Sie im Bereich Testen Sie diese Methode Folgendes ein:
- Name:
projects/PROJECT_ID
. Ersetzen SiePROJECT_ID
durch die ID Ihres Google Cloud-Projekts.
- Name:
Klicken Sie auf Execute.
Das folgende Antwortbeispiel enthält einige der zurückgegebenen, überwachten Ressourcentypen:
{ "resourceDescriptors": [ { "type": "aiplatform.googleapis.com/Endpoint", "displayName": "AI Platform Endpoint", "description": "A Cloud AI Platform API Endpoint where Models are deployed into it.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Endpoint", }, { "type": "aiplatform.googleapis.com/Featurestore", "displayName": "AI Platform Feature Store", "description": "A Cloud AI Platform Feature Store.", "labels": [{...}], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/aiplatform.googleapis.com/Featurestore", },
Wenn Sie die Anfrage als curl
-Befehl, HTTP-Anfrage oder in JavaScript ansehen möchten, klicken Sie in APIs Explorer auf fullscreen Vollbild.
C#
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Go
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
PHP
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Ressourcendeskriptoren abrufen
Verwenden Sie die Methode monitoredResourceDescriptors.get
, um einen bestimmten Deskriptor der überwachten Ressource abzurufen.
Sie müssen der API den vollständigen Namen des Deskriptors angeben, um einen bestimmten Deskriptor für eine überwachte Ressourcen abzurufen. Der vollständige Name besteht aus zwei Komponenten:
- Ein Präfix bestehend aus
projects/PROJECT_ID/monitoredResourceDescriptors
. - Der Wert
type
, der den Deskriptor der überwachten Ressource identifiziert, z. B.gce_instance
. Weitere Informationen zum Werttype
finden Sie auf dem Tab Protokoll in Ressourcentypen auflisten.
Das folgende Beispiel zeigt den vollständigen Namen einer überwachten Ressource:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Protokoll
So rufen Sie den Deskriptor für den Ressourcentyp gce_instance
ab:
Öffnen Sie die Referenzseite von
monitoredResourceDescriptors.get
.Geben Sie im Bereich Testen Sie diese Methode Folgendes ein:
Name:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Ersetzen Sie
PROJECT_ID
durch die ID Ihres Google Cloud-Projekts.
Klicken Sie auf Execute.
Das folgende Antwortbeispiel enthält den Deskriptor dieser überwachten Ressource:
{ "type": "gce_instance", "displayName": "VM Instance", "description": "A virtual machine instance hosted in Compute Engine.", "labels": [ { "key": "project_id", "description": "The identifier of the Google Cloud project associated with this resource, such as \"my-project\"." }, { "key": "instance_id", "description": "The numeric VM instance identifier assigned by Compute Engine." }, { "key": "zone", "description": "The Compute Engine zone in which the VM is running." } ], "name": "projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance" }
Wenn Sie die Anfrage als curl
-Befehl, HTTP-Anfrage oder in JavaScript ansehen möchten, klicken Sie in APIs Explorer auf fullscreen Vollbild.
C#
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Go
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Java
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Node.js
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
PHP
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Python
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Ruby
Richten Sie zur Authentifizierung bei Monitoring Standardanmeldedaten für Anwendungen ein. Weitere Informationen finden Sie unter Authentifizierung für eine lokale Entwicklungsumgebung einrichten.
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Nächste Schritte
- Informationen zum Lesen von Zeitreihendaten mit der Cloud Monitoring API finden Sie unter Zeitachsendaten abrufen.
- Eine Liste der Typen von überwachten Ressourcen, die für die Verwendung mit benutzerdefinierten Messwerten verfügbar sind, finden Sie unter Typ der überwachten Ressource auswählen.