Hinweise zur Terminologie

Die Wörter Name, Typ, Art, Messwert und Ressource erscheinen in verschiedenen Kombinationen und Kontexten im Zusammenhang mit Cloud Monitoring, und die Verwendungen sind nicht immer konsistent. Hier einige Beispiele für gängige Muster:

• 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

• Der String wie gcs_bucket kann so bezeichnet werden:

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

¹ Im Referenzmaterial der REST API wird auch häufig der Begriff Ressourcenname verwendet, der normalerweise nichts mit überwachten Ressourcen zu tun hat. Dieser Begriff wird unter Ressourcennamen ausführlicher beschrieben.

In diesem Abschnitt finden Sie 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 von name die vollqualifizierte Version des Messwerttyps. Der Wert name ist der Wert type, dem dieser String vorangestellt ist:

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.

Wichtiger Hinweis: In fast allen Fällen bezieht sich die Verwendung von "Messwerttyp", "Messwertname" oder "Messwerttypname" auf den hier beschriebenen Messwerttyp. Das Wort „Messwert“ steht in der Regel für die mit einem Messwerttyp verknüpfte Zeitachse. Der Begriff "überwachte Ressource" bezieht sich normalerweise auf den Typ oder eine bestimmte physische Entität, die durch einen Typ beschrieben wird.

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. Sie beziehen sich beide auf das Programmierprinzip "Datentyp".

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

Weitere Informationen finden Sie unter Messwerttypen und -typen.

Ressourcennamen

Das Muster zum Erstellen eines name-Werts durch Voranstellen eines Strings an einen type-Wert (oder einen anderen Wert) geht weit über Messwert- und überwachte Ressourcentypen hinaus. Es erscheint mit fast allen Daten, die eindeutig identifizierbare Daten erzeugen. Beispielsweise folgen sowohl MetricDescriptor als auch AlertPolicy diesem Muster.

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

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 (Beispiel): 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 (Beispiel): api
  • name: projects/[PROJECT_ID]/monitoredResourceDescriptors/api
• Benachrichtigungsrichtlinien: Werte des Präfixes und eine generierte ID zusammenführen
  • 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 bezieht sich nicht auf das Konzept der überwachten Ressourcen. Weitere Informationen zu Ressourcennamen beim Design einer API finden Sie unter Ressourcennamen.

Wichtiger Hinweis: Wenn in der Cloud Monitoring API ein name-Feld als "Ressourcenname" beschrieben wird, ist der Wert für dieses Feld eine vollständig qualifizierte Kennung, die durch die Verwendung eines type-Werts (oder eines anderen Felds) als Wert für den String, der den Ressourcentyp angibt, erstellt wurde.