MCP Tools Reference: monitoring.googleapis.com

Tool: list_metric_descriptors

Verwenden Sie dieses Tool als primäres Tool, um die Arten von Messwerten zu ermitteln, die in einem Google Cloud-Projekt verfügbar sind. Das ist ein guter erster Schritt, um zu verstehen, welche Daten für das Monitoring und zum Erstellen von Dashboards oder Benachrichtigungen verfügbar sind.

Das folgende Codebeispiel zeigt, wie Sie mit curl das MCP-Tool list_metric_descriptors aufrufen.

Curl-Anfrage
curl --location 'https://monitoring.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "list_metric_descriptors",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

Eingabeschema

Die ListMetricDescriptors-Anfrage.

ListMetricDescriptorsRequest

JSON-Darstellung
{
  "name": string,
  "filter": string,
  "pageSize": integer,
  "pageToken": string,
  "activeOnly": boolean
}
Felder
name

string

Erforderlich. Das Projekt, in dem die Anfrage ausgeführt werden soll. Das Format dafür ist:

projects/[PROJECT_ID_OR_NUMBER]
filter

string

Optional. Wenn dieses Feld leer ist, werden alle benutzerdefinierten und systemdefinierten Messwertdeskriptoren zurückgegeben. Andernfalls wird mit dem filter angegeben, welche Messwertdeskriptoren zurückgegeben werden sollen. Der folgende Filter stimmt beispielsweise mit allen benutzerdefinierten Messwerten überein:

metric.type = starts_with("custom.googleapis.com/")
pageSize

integer

Optional. Eine positive Zahl, die die maximale Anzahl der zurückzugebenden Ergebnisse angibt. Der Standard- und der Höchstwert sind 10.000. Wenn ein page_size-Wert <= 0 oder > 10.000 übergeben wird, werden stattdessen maximal 10.000 Ergebnisse zurückgegeben.

pageToken

string

Optional. Wenn dieses Feld nicht leer ist, muss es den nextPageToken-Wert enthalten, der von einem vorherigen Aufruf dieser Methode zurückgegeben wurde. Wenn Sie dieses Feld verwenden, gibt die Methode zusätzliche Ergebnisse aus dem vorherigen Methodenaufruf zurück.

activeOnly

boolean

Optional. Wenn „true“, werden in die Antwort nur Messwerte und überwachte Ressourcentypen mit aktuellen Daten (innerhalb von etwa 25 Stunden) aufgenommen. – Wenn in einem Messwertdeskriptor überwachte Ressourcentypen aufgeführt sind, werden nur die überwachten Ressourcentypen, für die der Messwerttyp aktuelle Daten enthält, in den zurückgegebenen Messwertdeskriptor aufgenommen. Wenn für keinen der überwachten Ressourcentypen aktuelle Daten vorhanden sind, wird der Messwertdeskriptor nicht zurückgegeben. – Wenn in einem Messwertdeskriptor die kompatiblen überwachten Ressourcentypen nicht aufgeführt sind, wird er nur zurückgegeben, wenn der Messwerttyp aktuelle Daten für einen überwachten Ressourcentyp enthält. Der zurückgegebene Deskriptor listet keine Typen von überwachten Ressourcen auf.

Ausgabeschema

Die ListMetricDescriptors-Antwort.

ListMetricDescriptorsResponse

JSON-Darstellung
{
  "metricDescriptors": [
    {
      object (MetricDescriptor)
    }
  ],
  "nextPageToken": string
}
Felder
metricDescriptors[]

object (MetricDescriptor)

Die Messwertdeskriptoren, die für das Projekt verfügbar sind und mit dem Wert von filter übereinstimmen, falls vorhanden.

nextPageToken

string

Wenn mehr Ergebnisse vorhanden sind, als zurückgegeben wurden, wird dieses Feld auf einen nicht leeren Wert gesetzt. Um die zusätzlichen Ergebnisse zu sehen, verwenden Sie diesen Wert als page_token im nächsten Aufruf dieser Methode.

MetricDescriptor

JSON-Darstellung
{
  "name": string,
  "type": string,
  "labels": [
    {
      object (LabelDescriptor)
    }
  ],
  "metricKind": enum (MetricKind),
  "valueType": enum (ValueType),
  "unit": string,
  "description": string,
  "displayName": string,
  "metadata": {
    object (MetricDescriptorMetadata)
  },
  "launchStage": enum (LaunchStage),
  "monitoredResourceTypes": [
    string
  ]
}
Felder
name

string

Der Ressourcenname des Messwertdeskriptors.

type

string

Der Messwerttyp, einschließlich des Präfixes des DNS-Namens. Der Typ ist nicht URL-codiert. Alle benutzerdefinierten Messwerttypen haben den DNS-Namen custom.googleapis.com oder external.googleapis.com. Messwerttypen sollten in einer natürlichen hierarchischen Gruppierung zusammengefasst werden. Beispiel:

"custom.googleapis.com/invoice/paid/amount"
"external.googleapis.com/prometheus/up"
"appengine.googleapis.com/http/server/response_latencies"
labels[]

object (LabelDescriptor)

Die Menge der Labels, die zum Beschreiben einer bestimmten Instanz dieses Messwerttyps verwendet werden können. Der Messwerttyp appengine.googleapis.com/http/server/response_latencies hat beispielsweise ein Label für den HTTP-Antwortcode, response_code. So können Sie sich die Latenzen für erfolgreiche Antworten oder nur für fehlgeschlagene Antworten ansehen.

metricKind

enum (MetricKind)

Gibt an, ob für den Messwert Momentanwerte oder Änderungen an einem Wert erfasst werden. Einige Kombinationen von metric_kind und value_type werden möglicherweise nicht unterstützt.

valueType

enum (ValueType)

Gibt an, ob es sich bei der Messung um eine Ganzzahl, eine Gleitkommazahl usw. handelt. Einige Kombinationen aus metric_kind und value_type werden möglicherweise nicht unterstützt.

unit

string

Die Einheiten, in denen der Messwert gemeldet wird. Dies gilt nur, wenn value_type den Wert INT64, DOUBLE oder DISTRIBUTION hat. Mit unit wird die Darstellung der gespeicherten Messwerte definiert.

In verschiedenen Systemen werden die Werte möglicherweise skaliert, um die Darstellung zu vereinfachen. So kann ein Wert von 0.02kBy möglicherweise als 20By und ein Wert von 3523kBy möglicherweise als 3.5MBy dargestellt werden. Wenn unit jedoch kBy ist, wird der Wert des Messwerts immer in Tausend Byte angegeben, unabhängig davon, wie er dargestellt wird.

Wenn Sie mit einem benutzerdefinierten Messwert die genaue Anzahl der von einem Job verwendeten CPU-Sekunden erfassen möchten, können Sie einen INT64 CUMULATIVE-Messwert erstellen,dessen unit s{CPU} (oder gleichwertig 1s{CPU} oder nur s) ist. Wenn der Job 12.005 CPU-Sekunden verwendet, wird der Wert als 12005 geschrieben.

Wenn Sie möchten, dass ein benutzerdefinierter Messwert Daten auf granularere Weise erfasst, können Sie alternativ einen DOUBLE CUMULATIVE-Messwert erstellen, dessen unit ks{CPU} ist, und dann den Wert 12.005 (12005/1000) schreiben oder Kis{CPU} verwenden und 11.723 (12005/1024) schreiben.

Die unterstützten Einheiten sind eine Teilmenge des Standards Unified Code for Units of Measure:

Grundeinheiten (UNIT)

  • bit Bit
  • By Byte
  • s Sekunde
  • min Minute
  • h Stunde
  • d Tag
  • 1 dimensionslos

Präfixe (PREFIX)

  • k Kilo (10^3)
  • M Mega (10^6)
  • G Giga (10^9)
  • T Tera (10^12)
  • P Peta (10^15)
  • E Exa (10^18)
  • Z zetta (10^21)
  • Y Yotta (10^24)
  • m milli (10^-3)

  • u Mikro (10^-6)
  • n Nano (10^-9)
  • p Piko (10^-12)
  • f Femto (10^-15)
  • a atto (10^-18)
  • z zepto (10^-21)
  • y yocto (10^-24)
  • Ki Kibi (2^10)

  • Mi Mebi (2^20)
  • Gi gibi (2^30)
  • Ti Tebi (2^40)
  • Pi pebi (2^50)

Grammatik

Die Grammatik umfasst auch diese Konnektoren:

  • / Division oder Verhältnis (als Infixoperator). Beispiele: kBy/{email} oder MiBy/10ms. /s sollte jedoch fast nie in einem Messwert unit enthalten sein. Raten sollten immer zur Abfragezeit aus dem zugrunde liegenden kumulativen oder Deltawert berechnet werden.
  • . Multiplikation oder Komposition (als Infix-Operator). Beispiele: GBy.d oder k{watt}.h.

Die Grammatik für eine Einheit lautet so:

Expression = Component { "." Component } { "/" Component } ;

Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ]
          | Annotation
          | "1"
          ;

Annotation = "{" NAME "}" ;

Hinweise:

  • Annotation ist nur ein Kommentar, wenn er auf ein UNIT folgt. Wenn die Annotation allein verwendet wird, entspricht die Einheit 1. Beispiele: {request}/s == 1/s, By{transmitted}/s == By/s.
  • NAME ist eine Folge von nicht leeren, druckbaren ASCII-Zeichen, die { oder } nicht enthalten.
  • 1 steht für eine dimensionslose Einheit von 1, z. B. in 1/s. Sie wird in der Regel verwendet, wenn keine der Basiseinheiten geeignet ist. „Neue Nutzer pro Tag“ kann beispielsweise als 1/d oder {new-users}/d dargestellt werden. Ein Messwert 5 würde „5 neue Nutzer“ bedeuten. Alternativ werden „Tausende von Seitenaufrufen pro Tag“ als 1000/d, k1/d oder k{page_views}/d dargestellt. Ein Messwert von 5.3 würde „5.300 Seitenaufrufe pro Tag“ bedeuten.
  • % steht für einen dimensionslosen Wert von 1/100 und kennzeichnet Werte, die einen Prozentsatz ergeben. Die Messwerte liegen also in der Regel im Bereich von 0 bis 100. Ein Messwert von 3 bedeutet „3 Prozent“.
  • 10^2.% gibt an, dass ein Messwert ein Verhältnis enthält, das normalerweise im Bereich 0 bis 1 liegt. Dieser Wert wird mit 100 multipliziert und als Prozentsatz angezeigt. Ein Messwert von 0.03 bedeutet also „3 Prozent“.
description

string

Eine detaillierte Beschreibung des Messwerts, die in der Dokumentation verwendet werden kann.

displayName

string

Ein prägnanter Name für den Messwert, der in Benutzeroberflächen angezeigt werden kann. Verwenden Sie die normale Groß- und Kleinschreibung ohne Schlusspunkt, z. B. „Anzahl der Anfragen“. Dieses Feld ist optional, sollte aber für alle Messwerte festgelegt werden, die mit für Nutzer sichtbaren Konzepten wie dem Kontingent verknüpft sind.

metadata

object (MetricDescriptorMetadata)

Optional. Metadaten, die zur Orientierung bei der Verwendung des Messwerts dienen können.

launchStage

enum (LaunchStage)

Optional. Die Einführungsphase der Messwertdefinition.

monitoredResourceTypes[]

string

Nur Lesezugriff. Falls vorhanden, kann ein time series, der teilweise durch einen Messwerttyp und einen MonitoredResourceDescriptor identifiziert wird, der diesem Messwerttyp zugeordnet ist, nur einem der hier aufgeführten überwachten Ressourcentypen zugeordnet werden.

LabelDescriptor

JSON-Darstellung
{
  "key": string,
  "valueType": enum (ValueType),
  "description": string
}
Felder
key

string

Der Schlüssel für dieses Label. Der Schlüssel muss die folgenden Kriterien erfüllen:

  • Darf nicht mehr als 100 Zeichen enthalten.
  • Entspricht dem folgenden regulären Ausdruck: [a-zA-Z][a-zA-Z0-9_]*
    • Das erste Zeichen muss ein Groß- oder Kleinbuchstabe sein.
    • Die restlichen Zeichen müssen Buchstaben, Ziffern oder Unterstriche sein.
valueType

enum (ValueType)

Der Datentyp, der dem Label zugewiesen werden kann.

description

string

Eine für Menschen lesbare Beschreibung des Labels.

MetricDescriptorMetadata

JSON-Darstellung
{
  "launchStage": enum (LaunchStage),
  "samplePeriod": string,
  "ingestDelay": string,
  "timeSeriesResourceHierarchyLevel": [
    enum (TimeSeriesResourceHierarchyLevel)
  ]
}
Felder
launchStage
(deprecated)

enum (LaunchStage)

Verworfen Stattdessen muss MetricDescriptor.launch_stage verwendet werden.

samplePeriod

string (Duration format)

Der Stichprobenzeitraum von Messwertdatenpunkten. Bei Messwerten, die regelmäßig geschrieben werden, werden aufeinanderfolgende Datenpunkte in diesem Zeitintervall gespeichert, wobei Datenverlust aufgrund von Fehlern nicht einberechnet wird. Messwerte mit einer höheren Granularität haben einen kürzeren Sampling-Zeitraum.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

ingestDelay

string (Duration format)

Die Verzögerung von Datenpunkten aufgrund der Aufnahme. Datenpunkte, die älter als dieser Wert sind, werden garantiert aufgenommen und stehen zum Lesen bereit, wobei Datenverlust aufgrund von Fehlern nicht einberechnet wird.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

timeSeriesResourceHierarchyLevel[]

enum (TimeSeriesResourceHierarchyLevel)

Der Umfang der Zeitachsendaten des Messwerts.

Dauer

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Vorzeichenbehaftete Sekunden des Zeitraums. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzwerte werden so berechnet: 60 Sek./Min. × 60 Min./Std. × 24 Std./Tag × 365,25 Tage/Jahr × 10.000 Jahre

nanos

integer

Signierte Sekundenbruchteile mit Nanosekunden-Auflösung des Zeitraums. Dauern von weniger als einer Sekunde werden mit dem Feld seconds = 0 und einem positiven oder negativen Feld nanos dargestellt. Bei Zeiträumen von einer Sekunde oder mehr muss ein Wert ungleich null für das Feld nanos dasselbe Vorzeichen wie das Feld seconds haben. Muss zwischen -999.999.999 und +999.999.999 liegen (einschließlich).

ValueType

Werttypen, die als Labelwerte verwendet werden können.

Enums
STRING Ein String mit variabler Länge, der 1.024 Zeichen nicht überschreiten darf. Dies ist der Standardwerttyp.
BOOL Boolesch; „true“ oder „false“.
INT64 Eine vorzeichenbehaftete 64-Bit-Ganzzahl.

MetricKind

Die Art der Messung. Sie beschreibt, wie die Daten gemeldet werden. Informationen zum Festlegen der Start- und Endzeit basierend auf „MetricKind“ finden Sie unter TimeInterval.

Enums
METRIC_KIND_UNSPECIFIED Diesen Standardwert nicht verwenden.
GAUGE Die Momentmessung eines Werts.
DELTA Die Änderung eines Werts während eines Zeitintervalls.
CUMULATIVE Ein über ein Zeitintervall hinweg kumulierter Wert. Kumulative Messungen in einer Zeitreihe sollten dieselbe Startzeit und ansteigende Endzeiten haben, bis ein Ereignis den kumulativen Wert auf null zurücksetzt und für die nachfolgenden Punkte eine neue Startzeit festlegt.

ValueType

Der Werttyp eines Messwerts.

Enums
VALUE_TYPE_UNSPECIFIED Diesen Standardwert nicht verwenden.
BOOL Der Wert ist ein boolescher Wert. Dieser Werttyp kann nur verwendet werden, wenn die Messwertart GAUGE ist.
INT64 Der Wert ist eine vorzeichenbehaftete 64-Bit-Ganzzahl.
DOUBLE Der Wert ist eine Gleitkommazahl mit doppelter Genauigkeit.
STRING Der Wert ist ein Textstring. Dieser Werttyp kann nur verwendet werden, wenn die Messwertart GAUGE ist.
DISTRIBUTION Der Wert ist ein Distribution.
MONEY Der Wert ist ein Geldwert.

LaunchStage

Die Einführungsphase, wie in den Einführungsphasen der Google Cloud Platform definiert.

Enums
LAUNCH_STAGE_UNSPECIFIED Diesen Standardwert nicht verwenden.
UNIMPLEMENTED Die Funktion ist noch nicht implementiert. Nutzer können sie nicht verwenden.
PRELAUNCH Funktionen vor der Markteinführung sind für Nutzer ausgeblendet und nur intern sichtbar.
EARLY_ACCESS Early-Access-Features sind auf eine ausgewählte Gruppe von Testern beschränkt. Wenn Sie diese Funktionen nutzen möchten, müssen Sie sich im Voraus registrieren und eine Trusted Tester-Vereinbarung unterzeichnen, die Vertraulichkeitsbestimmungen enthält. Die Funktionen können instabil sein und nicht abwärtskompatible Änderungen enthalten. Außerdem ist nicht gewährleistet, dass sie freigegeben werden.
ALPHA Alpha ist eine Testphase mit begrenzter Verfügbarkeit, bevor Versionen zur allgemeinen Verwendung freigegeben werden. Bis zur Alpha-Phase sind alle wichtigen Designprobleme behoben und wir überprüfen die Funktionalität. Alphakunden müssen den Zugriff beantragen, den anwendbaren Nutzungsbedingungen zustimmen und ihre Projekte auf die Zulassungsliste setzen lassen. Alphaversionen müssen nicht vollständig sein und sind weder mit SLAs noch mit technischen Supportverpflichtungen verbunden. Sie sind jedoch so weit entwickelt, dass Kunden sie in Testumgebungen oder für Tests mit eingeschränkter Nutzung verwenden können – genau wie in normalen Produktionsumgebungen.
BETA Beta ist der Punkt, an dem wir ein Release für die Kunden freigeben. Sie sind weder mit SLAs, noch mit technischen Supportverpflichtungen verbunden. Die Produkte enthalten alle vorgesehenen Funktionen, können jedoch noch offene Probleme aufweisen. Betareleases eignen sich nur eingeschränkt für Produktionsumgebungen.
GA GA-Funktionen stehen allen Entwicklern zur Verfügung und gelten als stabil und voll qualifiziert für den Einsatz in der Produktion.
DEPRECATED Verworfene Features werden an einem bestimmten Termin eingestellt oder entfernt. Weitere Informationen finden Sie in unseren Nutzungsbedingungen im Abschnitt „Richtlinie zur Einstellung von Produkten und Diensten“ und in der Dokumentation Google Cloud Platform-Dienste, die der Richtlinie zur Einstellung von Produkten und Diensten unterliegen.

TimeSeriesResourceHierarchyLevel

Die Ebene der Ressourcenhierarchie der Zeitreihendaten einer Messgröße.

Enums
TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED Diesen Standardwert nicht verwenden.
PROJECT Weist einem Projekt einen Messwert zu.
ORGANIZATION Schränkt einen Messwert auf eine Organisation ein.
FOLDER Weist einem Messwert einen Ordner zu.

Tool-Annotationen

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌