Zählermesswerte konfigurieren

In diesem Dokument wird erläutert, wie Sie mit der Google Cloud Console, der Logging API und der Google Cloud CLI einen logbasierten Zählermesswert erstellen.

Mit Zählermesswerten wird die Anzahl der Logeinträge gezählt, die einem bestimmten Filter entsprechen. Sie können beispielsweise einen logbasierten Messwert erstellen, mit dem die Anzahl der Logeinträge gezählt wird, die eine bestimmte Fehlermeldung enthalten. Logbasierte Messwerte können innerhalb eines einzelnen Google Cloud-Projekts oder in einem Log-Bucket angewendet werden.

Eine Übersicht über logbasierte Messwerte finden Sie unter Übersicht über logbasierte Messwerte.

Hinweise

Damit Sie logbasierte Messwerte verwenden können, benötigen Sie ein Google Cloud-Projekt mit aktivierter Abrechnung:
Achten Sie darauf, dass Ihre Rolle für Identity and Access Management die erforderlichen Berechtigungen zum Erstellen und Aufrufen logbasierter Messwerte sowie zum Erstellen von Benachrichtigungsrichtlinien enthält. Weitere Informationen finden Sie unter Berechtigungen für logbasierte Messwerte.

Logbasierten Zählermesswert erstellen

Mit dem Messwert werden die Logeinträge gezählt, die durch einen von Ihnen angegebenen Filter identifiziert wurden. Sie können in Ihrem Filter reguläre Ausdrücke verwenden. Wir empfehlen, einen Ressourcentyp anzugeben. Die Länge eines Filters darf 20.000 Zeichen nicht überschreiten.

Der Filter sollte keine vertraulichen Informationen enthalten. Filter werden als Dienstdaten behandelt.

Console

So erstellen Sie in der Google Cloud Console in Ihrem Google Cloud-Projekt einen Zählermesswert:

Wählen Sie im Navigationsbereich der Google Cloud Console Logging und dann Logbasierte Messwerte aus:
Zu Logbasierte Messwerte
Klicken Sie auf Messwert erstellen. Der Bereich Logmesswert erstellen wird angezeigt.
Legen Sie den Messwerttyp fest: Wählen Sie Zähler aus.
Legen Sie im Abschnitt Details die folgenden Felder fest:
- Name des Logmesswerts: Wählen Sie einen Namen aus, der unter den logbasierten Messwerten in Ihrem Google Cloud-Projekt eindeutig ist. Für die Benennung gelten einige Einschränkungen. Weitere Informationen dazu finden Sie unter Fehlerbehebung.
- Beschreibung: Geben Sie eine Beschreibung für den Messwert ein.
- Einheiten: Lassen Sie dieses Feld leer oder geben Sie die Zahl 1 ein.
Definieren Sie den Messwertfilter im Abschnitt Filterauswahl.
1. Wählen Sie mit Logbereich auswählen aus, ob der Filter auf alle Logs Ihres Google Cloud-Projekts oder nur auf Logs in einem bestimmten Bucket angewendet werden soll.
2. Erstellen Sie einen Filter, der nur die Logeinträge erfasst, die Sie in Ihrem Messwert mit der Logging-Abfragesprache zählen möchten. Sie können auch reguläre Ausdrücke verwenden, um Filter des Messwerts zu erstellen.
3. Klicken Sie auf Logvorschau, um zu sehen, welche Logeinträge Ihrem Filter entsprechen.
(Optional) Fügen Sie im Abschnitt Labels ein Label hinzu. Eine Anleitung zum Erstellen von Labels finden Sie unter Label erstellen.
Klicken Sie auf Messwert erstellen, um den Messwert zu erstellen.

gcloud

Mit dem folgenden Befehl können Sie einen logbasierten Messwert ohne benutzerdefinierte Labels erstellen:

gcloud logging metrics create METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  [--bucket-name="BUCKET_NAME"]

Mit dem folgenden Befehl wird beispielsweise ein logbasierter Messwert namens error_count auf Projektebene erstellt.

gcloud logging metrics create error_count \
     --description "Errors in syslog." \
     --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR"

Wenn Sie stattdessen einen logbasierten Messwert auf Bucket-Ebene erstellen möchten, geben Sie das Flag --bucket_name an:

gcloud logging metrics create error_count \
    --description "Errors in syslog." \
    --log-filter "resource.type=gce_instance AND log_id(\"syslog\") AND severity>=ERROR" \
    --bucket-name projects/my-project/locations/global/buckets/my-test-bucket

Eine Anleitung zum Erstellen von Labels finden Sie unter Labels erstellen.

API

Verwenden Sie zum Erstellen eines Zählermesswerts die Methode projects.metrics.create der Logging API. Sie können die Methode im APIs Explorer ausprobieren. Bereiten Sie die Argumente für die Methode so vor:

Geben Sie im Feld parent das Projekt oder den Bucket an, in dem der Messwert erstellt werden soll:
- Geben Sie für einen logbasierten Messwert auf Projektebene das Projekt an:
```
projects/PROJECT_ID
```
- Geben Sie für einen logbasierten Messwert auf Bucket-Ebene den Bucket an:
```
projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
```

Legen Sie für den Anfragetext ein LogMetric-Objekt fest. Hier sehen Sie ein Beispielobjekt für einen Zählermesswert:

{
  name:        "my-metric"
  description: "This is my metric."
  filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
  metricDescriptor: {
      labels: [
        {
          key: "my-label",
          valueType: STRING,
          description: "This is my label.",
        }
      ]
  },
  labelExtractors: {
    "my-label":
      "REGEXP_EXTRACT(jsonPayload.someField, \"before ([0-9]+) after\")",
    ...
  },
}

Hinweise:

Wählen Sie einen Messwertnamen aus, der unter den logbasierten Messwerten in Ihrem Projekt nur einmal vorkommt. Für die Benennung gelten einige Einschränkungen. Weitere Informationen dazu finden Sie unter Fehlerbehebung.
Bei Zählermesswerten sind die LogMetric-Felder valueExtractor und bucketOptions nicht relevant und werden ausgelassen.
Wenn Ihr Messwert keine Labels enthält, können Sie die Felder metricDescriptor und labelExtractors auslassen. Wenn Ihr Messwert über Labels verfügt, finden Sie unter Labels für logbasierte Messwerte eine Einführung in Labels und Details zu ihrer Erstellung in der API.

Weitere Informationen LogMetric.

Latenz neuer Messwerte

Der neue Messwert wird sofort in der Messwertliste des Log-Explorers und in den relevanten Menüs von Monitoring angezeigt. Die Daten sind in der Regel in weniger als einer Minute verfügbar.

Logbasierte Messwerte prüfen

So listen Sie die benutzerdefinierten logbasierten Messwerte in Ihrem Google Cloud-Projekt auf oder prüfen einen bestimmten Messwert in Ihrem Google Cloud-Projekt:

Console

Wählen Sie im Navigationsbereich der Google Cloud Console Logging und dann Logbasierte Messwerte aus:
Zu Logbasierte Messwerte
Im Bereich Benutzerdefinierte Messwerte werden die benutzerdefinierten logbasierten Messwerte im aktuellen Google Cloud-Projekt angezeigt:
Zum Aufrufen der Daten in einem logbasierten Messwert klicken Sie in der Zeile des Messwerts auf das Menü und wählen Sie Im Metrics Explorer ansehen aus.

gcloud

Verwenden Sie den folgenden Befehl, um die benutzerdefinierten logbasierten Messwerte in Ihrem Google Cloud-Projekt aufzulisten:

gcloud logging metrics list

Verwenden Sie den folgenden Befehl, um einen benutzerdefinierten logbasierten Messwert in Ihrem Google Cloud-Projekt anzuzeigen:

gcloud logging metrics describe METRIC_NAME

Rufen Sie mit dem folgenden Befehl die Hilfe auf:

gcloud logging metrics --help

Sie können die Zeitachsendaten eines Messwerts nicht über die Google Cloud CLI lesen.

API

Messwerte auflisten

Verwenden Sie die API-Methode projects.metrics.list, um die benutzerdefinierten logbasierten Messwerte in einem Google Cloud-Projekt aufzulisten. Geben Sie die Parameter der Methode so an:

parent: Der Ressourcenname des Google Cloud-Projekts: projects/PROJECT_ID.
pageSize: Die maximale Anzahl der Ergebnisse.
pageToken: Ruft die nächste Seite mit Ergebnissen auf. Informationen zur Verwendung von Seitentoken finden Sie unter projects.metrics.list.

Messwertdefinitionen abrufen

Verwenden Sie die API-Methode projects.metrics.get, um einen einzelnen benutzerdefinierten logbasierten Messwert abzurufen. Geben Sie die Parameter der Methode so an:

metricName: Der Ressourcenname des Messwerts:
```
projects/PROJECT_ID/metrics/METRIC_ID
```

Messwertdaten lesen

Verwenden Sie zum Lesen der Zeitachsendaten in einem logbasierten Messwert in der Cloud Monitoring API die Methode projects.timeseries.list. Weitere Informationen zu Zeitachsendaten finden Sie unter Zeitachsen lesen.

Zum Lesen eines einzelnen benutzerdefinierten logbasierten Messwerts geben Sie die Parameter der Methode mit diesem Messwerttyp und dieser ID ein:

logging.googleapis.com/user/METRIC_ID

Logbasierte Messwerte aktualisieren

Sie können einen benutzerdefinierten logbasierten Messwert bearbeiten, um seine Beschreibung, den Filter und die Namen der im Messwert referenzierten Felder zu ändern. Sie können dem Messwert neue Labels hinzufügen und die regulären Ausdrücke ändern, mit denen Werte für den Messwert und dessen Labels extrahiert werden. Wenn Sie einen Messwert auf Bucket-Ebene verwenden, können Sie auch den Bucket des Messwerts aktualisieren.

Es ist nicht möglich, die Namen oder Typen von benutzerdefinierten logbasierten Messwerten oder deren Labels zu ändern. Außerdem lassen sich vorhandene Labels in einem logbasierten Messwert nicht löschen.

So bearbeiten Sie einen logbasierten Messwert:

Console

Wählen Sie im Navigationsbereich der Google Cloud Console Logging und dann Logbasierte Messwerte aus:
Zu Logbasierte Messwerte
Klicken Sie im Menü für den zu ändernden logbasierten Messwert auf Messwert bearbeiten.
Ändern Sie nur die zulässigen Elemente des Messwerts.
Klicken Sie auf Messwert aktualisieren.

gcloud

Verwenden Sie die Google Cloud CLI, um die Beschreibung, die Filterabfrage und den Bucket eines Zählermesswerts zu ändern. Sie können einzelne oder alle Felder gleichzeitig aktualisieren.

gcloud logging update METRIC_NAME \
  --description="METRIC_DESCRIPTION" \
  --log-filter="FILTER" \
  --bucket-name=BUCKET_NAME

Wenn Sie den Bucket ändern, der mit einem Messwert auf Bucket-Ebene verknüpft ist, entsprechen die vor der Änderung erfassten Messwertdaten nicht mehr der aktuellen Konfiguration. Die für den vorherigen Bucket erfassten Messwertdaten werden nicht entfernt.

Wenn Sie Verteilungsmesswerte oder andere Zählermesswertfelder mit Ausnahme von METRIC_NAME aktualisieren möchten, erstellen Sie eine Datei mit der überarbeiteten Spezifikation Ihrer LogMetric im JSON- oder YAML-Format. Aktualisieren Sie dann den Messwert, indem Sie den Befehl update mit dem Feld „--config-from-file“ aufrufen und FILENAME durch den Namen Ihrer JSON- oder YAML-Datei ersetzen:

gcloud logging update METRIC_NAME --config-from-file FILENAME

Rufen Sie mit folgendem Befehl weitere Details ab:

gcloud logging metrics update --help

API

Verwenden Sie zum Bearbeiten eines logbasierten Messwerts in der API die Methode projects.metrics.update. Legen Sie die Felder so fest:

metricName: Der vollständige Ressourcenname des Messwerts:

projects/PROJECT_ID/metrics/METRIC_ID

Beispiel:

projects/my-gcp-project/metrics/my-error-metric

Der Anfragetext muss ein LogMetric-Objekt enthalten, das abgesehen von den gewünschten Änderungen und Ergänzungen genau dem vorhandenen Messwert entspricht.

Logbasierte Messwerte löschen

So löschen Sie einen benutzerdefinierten logbasierten Messwert:

Console

Wählen Sie im Navigationsbereich der Google Cloud Console Logging und dann Logbasierte Messwerte aus:
Zu Logbasierte Messwerte
Wählen Sie den zu löschenden Messwert aus und klicken Sie auf Löschen.

Alternativ können Sie im Menü des logbasierten Messwerts, den Sie löschen möchten, auf Messwert löschen klicken.

gcloud

Verwenden Sie den folgenden Befehl, um einen benutzerdefinierten logbasierten Messwert im aktuellen Google Cloud-Projekt zu löschen:

gcloud logging metrics delete METRIC_NAME

For more details, use the following command:

gcloud logging metrics delete --help

API

Verwenden Sie die Methode projects.metrics.delete in der API, um einen benutzerdefinierten logbasierten Messwert zu löschen.

Darüber hinaus finden Sie in der Google Cloud Console auf der Seite Logbasierter Messwert im Bereich Benutzerdefinierte Messwerte weitere Funktionen zum Verwalten der benutzerdefinierten Messwerte in Ihrem Google Cloud-Projekt. Weitere Informationen finden Sie im Bereich "Benutzerdefinierte Messwerte".