Hinweise zur Terminologie

Die Unterscheidung zwischen sich überschneidenden Begriffen wie Name, Typ, Art, Messwert und Ressource hilft Ihnen, die Cloud Monitoring-Dokumentation zu interpretieren und die richtigen Felder in Cloud Monitoring API-Anfragen anzugeben. Bei der gelegentlichen Verwendung wird oft nicht klar, wie sich Messwerttypen, Typen überwachter Ressourcen, Werttypen, Messwertarten und API-Ressourcennamen unterscheiden.

Häufige sich überschneidende Begriffe

Die folgenden Beispiele veranschaulichen, wie Monitoring-Begriffe und -Kennungen je nach Kontext oft synonym verwendet werden:

  • Der Begriff Messwert kann in verschiedenen Kontexten verwendet werden, um sich auf Folgendes zu beziehen:

    • Ein allgemeines "Element", das gemessen werden soll
    • Ein Messwerttyp
    • Eine Zeitreihe
    • Eine Reihe von Zeitachsen, die einem Messwerttyp zugeordnet sind
    • Die Metric-Struktur, eingebettet in eine TimeSeries-Struktur

  • Ein String wie storage.googleapis.com/api/request_count kann so bezeichnet werden:

    • Ein Messwert
    • Ein Messwertname
    • Ein Messwerttyp
    • Ein Messwerttypname

  • Ein String wie gcs_bucket kann auf eine der folgenden Arten bezeichnet werden:

    • Ein Ressourcenname 1
    • Eine überwachte Ressource
    • Entspricht einem Typ von überwachten Ressourcen
    • Ein Name einer überwachten Ressource

1 In der REST API-Referenz wird auch häufig der Begriff Ressourcenname verwendet, der in der Regel nichts mit überwachten Ressourcen zu tun hat. Dieser Begriff wird unter Ressourcennamen ausführlicher beschrieben.

Der Rest dieses Dokuments enthält einige Hinweise zu möglicherweise verwirrenden Begriffen.

Typen und Namen

Deskriptoren für Messwerttypen und überwachte Ressourcen haben sowohl Namen als auch Typen. Bei der gelegentlichen Verwendung werden die Begriffe häufig austauschbar verwendet.

Der String storage.googleapis.com/api/request_count ist beispielsweise ein Messwerttyp, wird jedoch auch als Name oder Typname bezeichnet.

Wenn Sie sich den Deskriptor für diesen Messwerttyp ansehen, sehen Sie die beiden Schlüssel/Wert-Paare name und type:

{
  "name": "projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count",
  ...
  "type": "storage.googleapis.com/api/request_count",
}

Der type in einem Messwertdeskriptor ist ein String, der Informationen über den Dienst codiert, der die Daten generiert (z. B. storage.googleapis.com) und was gemessen wird (api/request_count).

In einem Messwertdeskriptor ist der Wert des Felds name die vollständig qualifizierte Version des Messwerttyps. Der Wert name ist der Wert type mit dem Präfix dieses Strings:

projects/[PROJECT_ID]/metricDescriptors/

Ein ähnliches Muster gilt für überwachte Ressourcen. type ist ein Label für eine Art von Ressource, und name besteht aus dem Wert type mit dem Präfix dieses Strings:

projects/[PROJECT_ID]/monitoredResourceDescriptors/

Das folgende Beispiel entspricht dem Eintrag api in der Liste der überwachten Ressourcen:

{
  "type": "api",
  ...
  "name": "projects/[PROJECT_ID]/monitoredResourceDescriptors/api"
}

Der Wert von name innerhalb eines Projekts ist aus dem Wert von type vollständig vorhersagbar, aber nicht genau dasselbe. Allerdings werden die Begriffe in der gelegentlichen Diskussion oft ungenau verwendet.

Messwertart und Werttyp

Es gibt zwei weitere Begriffe, die mit "Messwerttyp" verwechselt werden können:

  • Werttyp
  • Messwertart

Diese Begriffe sind keine alternativen Begriffe für „Messwerttyp“.

"Werttyp" und "Messwerttyp" beschreiben die erfassten Daten. Beide beziehen sich auf das Programmierkonzept „Datentyp“.

  • Der Werttyp beschreibt die einzelnen Werte.
  • Der Messwerttyp beschreibt, wie die Werte miteinander zusammenhängen.

Weitere Informationen finden Sie unter Werttypen und Messwertarten.

Ressourcennamen

Das Muster, einen name-Wert zu erstellen, indem einem type-Wert (oder einem anderen Wert) ein String vorangestellt wird, geht weit über Messwert- und überwachte Ressourcentypen hinaus. Es erscheint mit fast allen Daten, die eindeutig identifizierbare Daten erzeugen. Beispiel: Sowohl MetricDescriptor als auch AlertPolicy folgen diesem Muster.

Der Wert des Felds name wird in der Referenzdokumentation oft als "Ressourcenname" beschrieben:

Ressourcenname in der API-Referenz

Hier einige Beispiele für ein paar Strukturen mit Ressourcennamen und deren Ableitung:

  • Messwertdeskriptoren: Fügen Sie die Werte des Präfixes und des Felds type zusammen:
    • Präfix: projects/[PROJECT_ID]/metricDescriptors
    • type (Stichprobe): storage.googleapis.com/api/request_count
    • name: projects/[PROJECT_ID]/metricDescriptors/storage.googleapis.com/api/request_count
  • Deskriptoren für überwachte Ressourcen: Fügen Sie die Werte des Präfixes und des Felds type zusammen:
    • Präfix: projects/[PROJECT_ID]/monitoredResourceDescriptors
    • type (Stichprobe): api
    • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
  • Benachrichtigungsrichtlinien: Verbinden Sie die Werte des Präfixes und einer generierten ID:
    • Präfix: projects/[PROJECT_ID]/alertPolicies
    • Warnungsrichtlinien-ID: eine beim Erstellen der Richtlinie generierte Zahl
    • name: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]

Der Begriff „Ressourcenname“ bezieht sich auf eine Ressource in der Hierarchie der API eines Dienstes und steht in keiner Beziehung zum Konzept der überwachten Ressourcen. Weitere Informationen zu Ressourcennamen beim Design einer API finden Sie unter Ressourcennamen.