Einführung in die Cloud Monitoring API

Mit der Cloud Monitoring API v3 können Sie Messwertdaten programmatisch abfragen und schreiben, überwachte Ressourcen in Gruppen organisieren und Dashboards, Benachrichtigungsrichtlinien, Service Level Objectives (SLOs) und Benachrichtigungskanäle verwalten. Methoden- und Ressourcenspezifikationen finden Sie in der Cloud Monitoring API (REST) und der Cloud Monitoring API (gRPC).

Projektnamen in der Monitoring API

Alle Methoden in der Monitoring API haben einen erforderlichen name-Parameter. Dieser Parameter hat in der Regel eine Beschreibung wie die folgende:

Erforderlich. Das Projekt, in dem die Anfrage ausgeführt werden soll. Das Format ist:
projects/[PROJECT_ID_OR_NUMBER]

In der Monitoring API identifiziert der Wert von PROJECT_ID_OR_NUMBER einen der folgenden Werte:

Bei einigen Methoden in der Monitoring API muss das Projekt ein Scoping-Projekt eines Messwertbereichs sein, bei anderen Methoden nicht. Eine kleine Anzahl an Methoden kann je nach Projekttyp unterschiedliche Ergebnisse zurückgeben.

Zur Beschreibung dieser Methodenklassen wird in diesem Artikel der Begriff Metrics API verwendet, um auf die folgenden Ressourcen in der Monitoring API zu verweisen:

Projekt zur Bereichsfestlegung eines Messwertbereichs erforderlich

Für alle Monitoring API-Methoden, die nicht Teil der Metrics API sind, muss der Parameter name auf ein Scoping-Projekt eines Messwertbereichs verweisen.

Scoping-Projekt eines Messwertbereichs nicht erforderlich

Bei keiner der Methoden in der Metrics API muss der Parameter name auf ein den Umfang festlegendes Projekt eines Messwertbereichs verweisen. Einige Methoden verhalten sich jedoch anders, wenn dies der Fall ist:

  • Die folgenden Methoden in der Metrics API werden für das benannteGoogle Cloud -Projekt ausgeführt. Diese Methoden wirken sich nur auf Daten im benannten Projekt aus, unabhängig davon, ob das Projekt auch ein Bereichsprojekt eines Messwertbereichs ist.

    • timeSeries.create
    • metricDescriptors.create
    • metricDescriptors.delete
    • metricDescriptors.get
    • monitoredResourceDescriptors.get

  • Die verbleibenden Methoden in der Metrics API verhalten sich so:

    • Wenn das benannte Projekt kein Scoping-Projekt eines Messwertbereichs ist, rufen die Methoden nur Daten aus dem benannten Projekt ab.
    • Wenn das benannte Projekt auch ein Scoping-Projekt eines Messwertbereichs ist, rufen die Methoden Daten sowohl aus dem benannten Projekt ab, als auch aus allen Projekten, die sie überwachen.

    Die Methoden in dieser Gruppe sind die folgenden:

    • timeSeries.list
    • timeSeries.query
    • metricDescriptors.list
    • monitoredResourceDescriptors.list

Informationen zum Einrichten eines Google Cloud -Projekts als Bereich festlegendes Projekt eines Messwertbereichs finden Sie unter Messwertbereiche – Übersicht.

API-Ressourcen

Messwerte

Die Monitoring API bietet Zugriff auf etwa 6.500 Cloud Monitoring-Messwerte vonGoogle Cloud und Amazon Web Services. Sie können eigene benutzerdefinierte Messwerte erstellen und Ihre Cloud-Ressourcen mithilfe von Gruppen organisieren.

Eine Einführung in Messwertkonzepte und die zugehörigen Datenstrukturen finden Sie unter Messwerte, Zeitachsen und Ressourcen.

Informationen zum Verwalten Ihrer benutzerdefinierten und integrierten Messwerte finden Sie unter Übersicht über benutzerdefinierte Messwerte.

Eine vollständige Liste der verfügbaren Messwerte finden Sie unter Messwertliste.

Überwachte Ressourcen

Bei einer überwachten Ressource werden Messwerte erfasst. Beispielsweise könnten Sie an der Aktivität einer VM-Instanz oder einer Hardware interessiert sein.

Eine Liste der verfügbaren überwachten Ressourcen finden Sie in der Liste der überwachten Ressourcen.

Überwachte Ressourcengruppen

Eine Gruppe ist eine dynamische Sammlung von überwachten Ressourcen. Sie konnten schon immer Gruppen manuell in der Google Cloud Console erstellen. Außerdem können Sie die Cloud Monitoring API verwenden, um Code zu schreiben, mit dem Gruppen erstellt und verwendet werden.

Weitere Informationen finden Sie in der API-Referenz für Group.

Benachrichtigungsrichtlinien

Eine Benachrichtigungsrichtlinie ist eine Konfigurationsressource, die die Kriterien für das Generieren von Benachrichtigungen und die Art der Benachrichtigung beschreibt, wenn diese Benachrichtigungen erstellt werden. In der Übersicht über Benachrichtigungen werden die grundlegenden Konzepte von Benachrichtigungsrichtlinien erläutert. Weitere Informationen finden Sie in der API-Referenz für AlertPolicy.

Mit der API können Sie auch Benachrichtigungsrichtlinien basierend auf einem Verhältnis von zwei Messwerten erstellen. Verhältnisse können derzeit nicht mit Monitoring in der Google Cloud Console erstellt werden. Weitere Informationen finden Sie unter MetricThreshold in der Referenz zu AlertPolicy.

Benachrichtigungskanäle

Ein Benachrichtigungskanal ist eine Konfigurationsressource, die beschreibt, wie Sie bei Benachrichtigungen informiert werden. Benachrichtigungskanäle können auf eine Vielzahl verschiedener Arten von Kommunikationsdiensten und -endpunkten verweisen. Diese werden in Deskriptoren angegeben. Die Deskriptoren bestimmen die Konfigurationsparameter, die in einem Channel-Objekt enthalten sind.

Weitere Informationen finden Sie in der NotificationChannel-Referenz und der NotificationChannelDescriptor-Referenz.

Dienstmonitoring

Die Ressourcen zur Dienstüberwachung werden zum Einrichten von Zielen auf Dienstebene verwendet, mit denen die Integrität Ihrer Dienste überwacht werden kann.

Service Monitoring fügt der Monitoring API die folgenden Ressourcen hinzu:

Weitere Informationen zu diesen Dienst-Monitoring-Konzepten und zur Verwendung der API finden Sie unter SLO-Monitoring.

Dashboards

Mit dem Endpunkt Dashboards können Sie sowohl Dashboards als auch Diagramme programmatisch erstellen und bearbeiten. Informationen zur Verwendung dieses Endpunkts zum Verwalten von Dashboards und Diagrammen finden Sie unter Dashboards mithilfe der API erstellen und verwalten.

Monitoring-Abfragesprache

Monitoring Query Language (MQL) bietet eine textbasierte Schnittstelle zum Abfragen von Zeitachsendaten aus Cloud Monitoring. MQL verwendet ein Pipeline-Abfragemodell und ist aussagekräftiger als Monitoring-Filter. Sie können MQL-Abfragen über die Monitoring API oder den Code-Editor verwenden.

Allgemeine Informationen zu MQL finden Sie unter Monitoring Query Language – Übersicht.

Informationen zum Abrufen von Zeitreihendaten mit MQL über die Monitoring API finden Sie in der API-Referenz für die Methode timeSeries.query.

Filter

In der Monitoring API werden Filter verwendet, um Messwerte auszuwählen, Zeitreihendaten abzurufen und überwachte Ressourcen in Gruppen zusammenzufassen. Weitere Informationen finden Sie unter Monitoring-Filter.

Die Monitoring API verwendet außerdem Filter, um die Ergebnismenge bestimmter list-Vorgänge einzuschränken. Weitere Informationen zum Verwalten der Ergebnisse der Methoden alertPolicies.list und notificationChannels.list finden Sie unter Referenz: Sortieren und Filtern.

Nächste Schritte