In diesem Dokument wird erläutert, wie Sie mit der Cloud Monitoring API Listen oder Beschreibungen für Folgendes abrufen:
- In Ihrem Projekt definierte benutzerdefinierte Messwerttypen.
- 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
external.googleapis.com/bluemedora/generic_node/
. - Von Google Cloud bereitgestellte integrierte Messwerttypen. Diese Messwerttypen können Ihnen beim Entwerfen Ihrer benutzerdefinierten Messwerte helfen. Informationen zu diesen Messwerten finden Sie in der Dokumentation. Weitere Informationen finden Sie in der Liste der Messwerte.
- Überwachte Ressourcentypen für Ihr Projekt. Informationen zu diesen Ressourcen finden Sie in der Dokumentation. Siehe Liste der überwachten Ressourcen.
Es gibt mehrere Möglichkeiten, die auf dieser Seite beschriebenen API-Methoden zu verwenden:
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.
Hinweis
- Eine Einführung in Messwerte und überwachte Ressourcen finden Sie unter Messwerte, Zeitachsen und Ressourcen.
Messwertdeskriptoren auflisten
Messwertdeskriptoren sind die Schemas, die Messwerte definieren. Bei den verfügbaren Messwertdeskriptoren finden Sie Details zu den gewünschten Messwerten:
- Integrierte Messwerte: Sie können API-Anfragen an jedes vorhandene Projekt senden oder die Dokumentation zu Messwertlisten verwenden.
- Benutzerdefinierte und externe Messwerte: Sie müssen die API-Anfrage an ein Projekt senden, in dem der benutzerdefinierte Messwert definiert ist oder in dem Zeitachsendaten 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
Im Folgenden finden Sie Beispielparameter für metricDescriptors.list
für die Rückgabe von Compute Engine-Messwerten:
- Name:
projects/PROJECT_ID
- Filter:
metric.type = starts_with("compute.googleapis.com")
Bevor Sie auf die Schaltfläche Execute (Ausführen) klicken, ersetzen Sie PROJECT_ID
durch eine gültige ID.
Das folgende Ausgabebeispiel enthält zwei der zahlreichen Compute Engine-Messwerte, die dem Filter entsprechen:
"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
gibt den Messwertdeskriptor an, z. B. compute.googleapis.com/firewall/dropped_packets_count
. Dieser Wert wird manchmal auch als "Messwerttyp" oder "Messwerttypname" bezeichnet.
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Messwertdeskriptoren abrufen
Verwenden Sie die Methode metricDescriptors.get
, um Informationen zu einem bestimmten 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
Verwenden Sie den folgenden Parameter für metricDescriptors.get
, um Details zum Compute Engine-Messwert /firewall/dropped_packets_count
abzurufen:
- Name:
projects/PROJECT_ID/metricDescriptors/compute.googleapis.com/firewall/dropped_packets_count
Bevor Sie auf die Schaltfläche Execute (Ausführen) klicken, ersetzen Sie PROJECT_ID
durch eine gültige ID.
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", }
C#
Go
Java
Node.js
PHP
Python
Ruby
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
Verwenden Sie zum Abrufen einer aktuellen Liste der überwachten Ressourcentypen monitoredResourceDescriptors.list
mit den folgenden Beispielparametern:
- Name:
projects/PROJECT_ID
Bevor Sie auf die Schaltfläche Execute (Ausführen) klicken, ersetzen Sie PROJECT_ID
durch eine gültige ID.
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", },
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Ressourcendeskriptoren abrufen
Details zu einem bestimmten Typ von überwachter Ressource erhalten Sie mit der Methode monitoredResourceDescriptors.get
.
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
Verwenden Sie den folgenden Parameter für monitoredResourceDescriptors.get
method, um Details zum Ressourcentyp gce_instance
abzurufen:
- Name:
projects/PROJECT_ID/monitoredResourceDescriptors/gce_instance
Bevor Sie auf die Schaltfläche Execute (Ausführen) klicken, ersetzen Sie PROJECT_ID
durch eine gültige ID.
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" }
C#
Go
Java
Node.js
PHP
Python
Ruby
Wenn Probleme auftreten, lesen Sie Fehlerbehebung bei API-Aufrufen.
Nächste Schritte
Informationen zur Verwendung der Cloud Monitoring API zum Lesen von Zeitachsendaten finden Sie unter Messwertdaten lesen.
Eine Liste der Typen von überwachten Ressourcen, die Sie für benutzerdefinierte Messwerte verwenden können, finden Sie unter Typ einer überwachten Ressource auswählen.