Einige oder alle Informationen auf dieser Seite gelten möglicherweise nicht für Cloud de Confiance von S3NS. Weitere Informationen finden Sie unter Unterschiede zu Google Cloud.

Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Monitoring-Filter

Mit Filtern in der Cloud Monitoring API können Sie bestimmte Zeitreihen, Messwerttypen und überwachte Ressourcen in API-Anfragen auswählen.

Hinweis

Wenn Sie mit Messwerten, Zeitreihen und überwachten Ressourcen nicht vertraut sind, lesen Sie den Hilfeartikel Messwerte, Zeitreihen und Ressourcen.

Wenn Sie mit Labels nicht vertraut sind, finden Sie eine Einführung unter Labels.

Filter verwenden

Sie können Filter in der Monitoring API für Folgendes verwenden:

Wählen Sie die spezifischen Zeitreihendaten aus, die von einer list-API-Anfrage zurückgegeben werden. Mit dem Filter können Zeitreihen anhand der überwachten Ressourcenattribute und Messwertattribute der Daten ausgewählt werden. Weitere Informationen und Beispiele finden Sie unter Zeitreihendaten abrufen.

Listen Sie bestimmte Messwerttypen auf. Weitere Informationen und Beispiele finden Sie unter Messwertdeskriptoren auflisten.
Listen Sie bestimmte überwachte Ressourcentypen au. Weitere Informationen und Beispiele finden Sie unter Überwachte Ressourcendeskriptoren auflisten.

Die Auswahl filtern

Ein Filter besteht aus mindestens einem Selektor, d. h. einem Filter-Keyword. Die folgenden Beispiele veranschaulichen die verschiedenen Selektoren:

resource: Stimmt mit überwachten Ressourcen eines bestimmten Typs oder mit bestimmten Labelwerten überein.
- Der folgende Filter stimmt mit allen überwachten Ressourcen überein, die Compute Engine-VM-Instanzen sind:
```
resource.type = "gce_instance"
```
metric: Stimmt mit einem bestimmten Messwerttyp oder einer bestimmten Zeitreihe mit einem bestimmten Label überein, das mit einem bestimmten Wert übereinstimmt.
- Der folgende Filter stimmt mit einem bestimmten Messwerttyp überein:
```
metric.type = "compute.googleapis.com/instance/cpu/usage_time"
```
- Der folgende Filter gleicht Zeitreihen mit einem Label namens instance_name ab, dessen Wert mit gke-hipster oder gke-nginx beginnt:
```
metric.labels.instance_name = monitoring.regex.full_match("gke-(hipster|nginx).*")
```

In der folgenden Tabelle sehen Sie, welche Selektoren in Filtern basierend auf dem Monitoring API-Aufruf zulässig sind:

Zweck des Filters	`resource`-Auswahl	`metric`-Auswahl
Zeitachsen auflisten	Ja	Ja ^*
Messwertdeskriptoren auflisten		Ja
Listen Sie überwachte Ressourcendeskriptoren auf.	Ja

^* Beim Auflisten von Zeitreihen müssen Sie genau einen Messwerttyp angeben.

In den folgenden Abschnitten finden Sie Beispiele für typische Anwendungsfälle von Monitoring-Filtern. Eine vollständige Erläuterung der verfügbaren Filterobjekte und ‑operatoren finden Sie unter Filtersyntax.

Zeitreihendaten abrufen

Methode: projects.timeSeries.list
Filterobjekte: project, resource.type, resource.labels.[KEY], metric.type, metric.labels.[KEY]

Eine Zeitreihe ist eine Liste von Datenpunkten mit Zeitstempel eines Messwerttyps aus einer bestimmten überwachten Ressource. Weitere Informationen finden Sie unter Messwertmodell. Der Messwerttyp wird durch einen Messwertdeskriptor und die überwachte Ressource durch einen Deskriptor für überwachte Ressourcen angegeben.

Der für die Methode timeSeries.list angegebene Filter muss einen metric-Selektor enthalten, der genau einen Messwerttyp angibt:

Verwenden Sie den folgenden Filter, um alle Zeitreihen für einen bestimmten Messwerttyp zurückzugeben:
```
metric.type = "compute.googleapis.com/instance/cpu/usage_time"
```

Verwenden Sie den folgenden Filter, um alle Zeitreihen einer bestimmten Compute Engine-Instanz zurückzugeben:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = "my-instance-name"

Verwenden Sie den folgenden Filter, um alle Zeitreihen von Compute Engine-Instanzen zurückzugeben, deren Namen mit frontend- beginnen:
```
metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = starts_with("frontend-")
```

Verwenden Sie den folgenden Filter, um alle Zeitreihen von Compute Engine-Instanzen zurückzugeben, deren Namen mit gke-hipster oder gke-nginx beginnen:

metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
metric.labels.instance_name = monitoring.regex.full_match("^gke-(hipster|nginx).*")

Messwertdeskriptoren auflisten

Methode: projects.metricDescriptors.list
Filterobjekte: project, metric.type

Verwenden Sie einen Filter, um die abgerufenen Messwertdeskriptoren einzuschränken.

Wenn Sie beispielsweise nur die Compute Engine-Messwertdeskriptoren zurückgeben möchten, verwenden Sie den folgenden Filter:

metric.type = starts_with("compute.googleapis.com")

Eine vollständige Liste der verfügbaren Messwerttypen finden Sie unter Messwertliste. Eine Übersicht über die Benennung von Messwerten finden Sie unter Namenskonventionen für Messwerte.

Überwachte Ressourcendeskriptoren auflisten

Methode: projects.monitoredResourceDescriptors.list
Objekte filtern: resource.type

Verwenden Sie einen Filter, um die abgerufenen Deskriptoren für überwachte Ressourcen einzuschränken.

Wenn Sie beispielsweise nur die Deskriptoren für überwachte Pub/Sub-Ressourcen abrufen möchten, verwenden Sie den folgenden Filter:

resource.type = starts_with("pubsub")

Eine vollständige Liste der von Monitoring definierten überwachten Ressourcentypen finden Sie unter Liste der überwachten Ressourcen.

Beispiele

In den Filterbeispielen werden der folgende Messwertdeskriptor, der überwachte Ressourcendeskriptor und die VM-Instanz vereinfacht verwendet:

    # Metric descriptor:
    { "name": "projects/my-project-id/metricDescriptors/compute.googleapis.com%2Finstance%2Fdisk%2Fread_bytes_count",
      "type": "compute.googleapis.com/instance/disk/read_bytes_count",
      "labels": [ { "key": "device_name",
                    "description": "The name of the disk device." } ] }

    # Monitored resource descriptor:
    {  "name": "monitoredResourceDescriptors/gce_instance",
       "type": "gce_instance",
       "labels": [
         { "key": "instance_id",
           "description": "The instance ID provided by Google Compute Engine." },
         { "key": "zone",
           "description": "The Google Cloud Platform zone hosting the instance."
         } ] }

    # Resource descriptor for a virtual machine instance.
    { "type": "gce_instance",
      "instance_id": "1472038649266883453",
      "zone": "us-east-1b",
      "disks": [ "log_partition" ],
      "machine_type": "n1-standard-2",
      "tags": { "environment": "bleeding-edge",
                "role": "frobulator" },
      "project_id": "my-project-id" }

Beispiele zum Abrufen von Messwerten

Wenn Sie die Bandbreitennutzung für Lesevorgänge auf Laufwerken für alle Instanzen und alle Geräte anfordern möchten, definieren Sie einen Filter wie folgt. Dieser Filter gibt für jede Instanz eine separate Zeitreihe zurück, die die Lesebandbreite für jedes Gerät enthält:

metric.type = "compute.googleapis.com/instance/disk/read_bytes_count"

Wenn Sie die Anfrage so verfeinern möchten, dass nur die Lesebandbreite für das Laufwerk mit dem Namen „log_partition“ auf jeder Instanz abgefragt wird, definieren Sie den Filter so: Dieser Filter gibt für jede Instanz höchstens eine Zeitreihe zurück, je nachdem, ob auf dieser Instanz ein Gerät mit diesem Namen vorhanden ist:

metric.type = "compute.googleapis.com/instance/disk/read_bytes_count" AND
metric.labels.device_name = "log_partition"

Wenn Sie die Anfrage auf eine einzelne Instanz beschränken möchten, geben Sie diese Instanz an:

resource.type = "gce_instance" AND
resource.labels.instance_id = "1472038649266883453" AND
metric.type = "compute.googleapis.com/instance/disk/read_bytes_count" AND
metric.labels.device_name = "log_partition"

Referenz: Filtersyntax

Eine Übersicht über Filter mit Beispielen finden Sie unter Filter verwenden.

Ein Monitoring-Filter ist ein String, der aus bis zu zwei Arten von Selektoren besteht:

    <monitoring_filter> ::= <resource_selector> AND
                             <metric_selector>

Der Filter stimmt mit einem Element überein, wenn alle enthaltenen Selektoren mit dem Element übereinstimmen. Wie in den folgenden Abschnitten beschrieben, können einige Selektoren mehrere Vergleiche enthalten, die durch AND oder OR verbunden sind. Die Reihenfolge der Selektoren im Filter spielt keine Rolle, aber Vergleiche für verschiedene Selektoren dürfen nicht vermischt werden.

Je nach Zweck des Filters können bestimmte Selektoren erforderlich, optional oder unzulässig sein. Der Filter, der zum Auflisten von Zeitreihen verwendet wird, muss beispielsweise einen Messwertselektor enthalten.

Vergleiche

Filter und ihre Selektoren werden aus Vergleichen erstellt. Jeder Vergleich hat das folgende Format:

[OBJECT]: Wählt einen zu testenden Wert aus. Eine der folgenden Optionen:
```
metric.type
metric.labels.[KEY]
resource.type
resource.labels.[KEY]
    
```
[KEY] ist ein Name, z. B. zone oder instance_id.

[KEYSTRING] kann ein Name sein. Wenn er Sonderzeichen enthält, muss er in Anführungszeichen (") gesetzt werden.

[OPERATOR]: ein Vergleichsoperator, einer der folgenden:

=            # equality (case-sensitive)
> < >= <=    # numeric ordering
!=           # not equal
:            # "has" substring match and test for key (case-sensitive)

[VALUE]: ein Literalwert oder ein integrierter Funktionsaufruf; einer der folgenden Werte:
```
<string>     # "a Unicode string". Don't use apostrophes (`'`) to quote strings.
<bool>       # true or false
<number>     # 0, -2, 123456, 3.14156
<function>   # operators on the right side of '=' or '!=':
             #   starts_with(<string>)
             #   ends_with(<string>)
             #   has_substring(<string> [, ignore_case=false])
             #   one_of(<string>,...,<string>) for up to 100 strings
             #   monitoring.regex.full_match(<RE2-string>)
    
```
Außer bei Verwendung in der Methode timeSeries.list akzeptiert der Filter has_substring ein optionales zweites Argument, das angibt, ob bei der Übereinstimmung die Groß-/Kleinschreibung ignoriert wird oder nicht. Der Standardwert ist false, sodass bei der Standardübereinstimmung die Groß-/Kleinschreibung berücksichtigt wird:
- Groß-/Kleinschreibung beachten: display_name=has_substring("Demo")
- Groß-/Kleinschreibung beachten: display_name=has_substring("Demo", false)
- Groß-/Kleinschreibung wird nicht beachtet: display_name=has_substring("Demo", true)
Bei Verwendung in der Methode timeSeries.list wird nur das Formular has_substring(<string>) unterstützt.

Der Filter monitoring.regex.full_match verwendet einen String mit regulärem Ausdruck in der RE2-Syntax.

Mit den folgenden Operatoren können Sie Vergleiche gruppieren oder ändern. OR hat eine höhere Priorität als AND. Die Operatoren müssen in Großbuchstaben geschrieben werden:

(...)        # grouping comparisons
AND          # conjunction (optional but recommended)
OR           # disjunction

Der Operator AND kann zwischen Operatoren weggelassen werden, ist jedoch klarer und weniger fehleranfällig.

Der Vergleich x = one_of("a", "b", "c") entspricht Folgendem:

(x = "a" OR x = "b" OR x = "c")

Die Auswahl filtern

Verwenden Sie Selektoren, um die Filterauswahl auf bestimmte Elemente zu beschränken. In den folgenden Abschnitten werden Klammern zur Darstellung von Wiederholungen verwendet. Die Notation <x> {OR <y>} bedeutet beispielsweise, dass Sie Folgendes schreiben können:

<x>
<x> OR <y>
<x> OR <y> OR <y>
<x> OR <y> OR <y> OR <y>
...

Ressourcenauswahl

Eine Ressourcenauswahl beschränkt die Filterauswahl auf Ressourcen oder mit Ressourcen verknüpfte Elemente, die einen bestimmten Ressourcentyp oder bestimmte Labelwerte haben:

<resource_selector> ::= <resource_type_expression>
                      | <resource_label_expression>
                      | <resource_type_expression> AND <resource_label_expression>

<resource_type_expression> ::= resource.type '=' <string>
                             | resource.type ':' <string>
                             | resource.type '=' starts_with '(' <string> ')'
                             | resource.type '=' ends_with '(' <string> ')'

<r_label_comparison> ::= resource.labels.[KEY] '=' (<string> | <bool>)
                       | resource.labels.[KEY] ':' <string>
                       | resource.labels.[KEY] '=' (starts_with | ends_with) '(' <string> ')'
                       | resource.labels.[KEY] ('=' | '>' | '<' | '>=' | '<=') <number>

<resource_label_expression> ::= <r_label_comparison> {AND <r_label_comparison>}
                              | <r_label_comparison> {OR <r_label_comparison>}

Wenn Sie mehr als ein <r_label_comparison> in Ihrem Selektor verwenden, setzen Sie alle in Klammern, um die Lesbarkeit zu verbessern.

Messwertauswahl

Eine Messwertauswahl gibt bestimmte Messwerte oder Messwertdeskriptoren an, indem der Messwerttyp und die Messwertlabels begrenzt werden. Bei Verwendung mit der Methode projects.timeSeries.list muss der Messwertselektor einen einzelnen Messwerttyp angeben:

<metric_selector> ::= <metric_name_expression> [AND <metric_label_expression>]

<metric_name_expression> ::= metric.type '=' <string>
                           | metric.type ':' <string>
                           | metric.type '=' starts_with '(' <string> ')'
                           | metric.type '=' ends_with '(' <string> ')'

<metric_label_comparison> ::= metric.labels.[KEY] '=' <string> | <bool>
                            | metric.labels.[KEY] ':' <string>
                            | metric.labels.[KEY] '=' starts_with '(' <string> ')'
                            | metric.labels.[KEY] '=' ends_with '(' <string> ')'
                            | metric.labels.[KEY] ('=' | '>' | '<' | '>=' | '<=') <number>

<metric_label_expression> ::= <metric_label_comparison> {[AND] <metric_label_comparison>}
                            | <metric_label_comparison> {OR <metric_label_comparison>}

Mit dem folgenden Filter können Sie beispielsweise eine Zeitreihe für eine bestimmte Datenbankinstanz abrufen:

metric.type = "cloudsql.googleapis.com/database/state" AND
(metric.labels.resource_type = "instance" AND
 metric.labels.resource_id = "abc-123456")