Einführung in die Cloud Monitoring API

Auf dieser Seite werden einige Funktionen der Cloud Monitoring API v3 beschrieben.

Die API-Referenzdokumentation finden Sie auf einer der folgenden Seiten:

Projektnamen in der Monitoring API

Alle Methoden in der Monitoring API haben einen erforderlichen name-Parameter. Dieser Parameter hat normalerweise eine Beschreibung wie diese:

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

In der Monitoring API gibt der Wert von PROJECT_ID_OR_NUMBER eine der folgenden Optionen an:

  • Ein Google Cloud-Projekt
  • Ein Google Cloud-Projekt, das auch ein Scoping-Projekt eines Messwertbereichs ist

Bei einigen Methoden in der Monitoring API muss das Projekt ein Bereich eines Messwertbereichs sein. Für andere Methoden ist dies nicht erforderlich. 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:

Scoping-Projekt 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

Keine der Methoden in der Metrics-API erfordert, dass der Parameter name auf ein Scoping-Projekt eines Messwertbereichs verweist. Einige Methoden verhalten sich jedoch anders, wenn es so ist:

  • Folgende Methoden in der Metrics API werden im benannten 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 funktionieren 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 Cloud-Projekts als Scoping-Projekt für einen Messwertbereich finden Sie unter Projekt für Monitoring konfigurieren.

API-Ressourcen

Messwerte

Mit der Monitoring API haben Sie Zugriff auf über 1.500 Cloud Monitoring-Messwerte von Google Cloud und Amazon Web Services. Sie können eigene benutzerdefinierte Messwerte erstellen und Ihre Cloudressourcen 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 Messwerte und der integrierten Messwerte finden Sie unter Benutzerdefinierte Messwerte verwenden.

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 können Gruppen immer manuell in der Monitoring-Konsole erstellen und mit der Cloud Monitoring API Code schreiben, der Gruppen erstellt und verwendet.

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

Benachrichtigungsrichtlinien

Eine Benachrichtigungsrichtlinie ist eine Konfigurationsressource, die die Kriterien zum Generieren von Vorfällen beschreibt und wie Sie benachrichtigt werden, wenn diese Vorfälle erstellt werden. Unter Benachrichtigungskonzepte 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. Sie können derzeit keine Verbindungen erstellen, wenn Sie Monitoring in der Google Cloud Console verwenden. Weitere Informationen finden Sie unter MetricThreshold in der AlertPolicy-Referenz.

Benachrichtigungskanäle

Ein Benachrichtigungskanal ist eine Konfigurationsressource, die beschreibt, wie Sie bei Vorfällen benachrichtigt 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 nach API 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 Abfrageeditor verwenden.

Allgemeine Informationen zu MQL finden Sie unter Monitoring-Abfragesprache verwenden.

Informationen zum Verwenden von MQL zum Abrufen von Zeitachsendaten mithilfe der Monitoring API finden Sie in der API-Referenz für die Methode timeSeries.query.

Weitere Informationen über das Erstellen von Dashboards mit MQL-basierten Diagrammen und der Monitoring API finden Sie in der API-Referenz für das Objekt TimeSeriesQuery. Dieses Objekt liefert den Mechanismus zum Abrufen des Datasets für ein Diagramm oder eine Kurzübersicht.

Filter

Die Monitoring API verwendet Filter, um Messwerte auszuwählen, Zeitachsendaten abzurufen und überwachte Ressourcen in Gruppen zusammenzufassen. Weitere Informationen finden Sie unter Filter überwachen.

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

Weitere Informationen