Zählermesswerte konfigurieren

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

Zählermesswerte zählen die Anzahl der Logeinträge, 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 in einem einzelnen Google Cloud Projekt oder in einem Log-Bucket angewendet werden.

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

Hinweise

  1. Wenn Sie logbasierte Messwerte verwenden möchten, benötigen Sie ein Google Cloud -Projekt mit aktivierter Abrechnungsfunktion:

    1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    3. Make sure that billing is enabled for your Google Cloud project.

    4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

      Go to project selector

    5. Make sure that billing is enabled for your Google Cloud project.

    6. Prüfen Sie, ob Ihre IAM-Rolle (Identity and Access Management) die Berechtigungen enthält, die zum Erstellen und Aufrufen logbasierter Messwerte und zum Erstellen von Benachrichtigungsrichtlinien erforderlich sind. Weitere Informationen finden Sie unter Berechtigungen für logbasierte Messwerte.

      7. Logbasierten Messwert vom Typ „Zähler“ erstellen

      Mit dem Messwert werden die Logeinträge gezählt, die durch einen von Ihnen angegebenen Filter identifiziert werden. Sie können reguläre Ausdrücke in Ihrem Filter verwenden. Wir empfehlen, einen Ressourcentyp anzugeben. Ein Filter darf nicht länger als 20.000 Zeichen sein.

      Geben Sie keine vertraulichen Informationen in den Filter ein. Filter werden als Dienstdaten behandelt.

      Console

      So erstellen Sie einen Zählermesswert in derGoogle Cloud console in Ihrem Google Cloud Projekt:

      1. Rufen Sie in der Google Cloud Console die Seite Logbasierte Messwerte auf:

        Zu Logbasierte Messwerte

        Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

      2. Klicken Sie auf Messwert erstellen. Der Bereich Logmesswert erstellen wird angezeigt.

      3. Legen Sie den Messwerttyp fest: Wählen Sie Zähler aus.

      4. 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 einmalig 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.

      5. Definieren Sie den Messwertfilter im Abschnitt Filterauswahl.

        1. Verwenden Sie das Menü Projekt oder Log-Bucket auswählen, um festzulegen, ob der Messwert die Logeinträge in Ihrem Google Cloud Projekt oder nur die Logeinträge in einem bestimmten Log-Bucket zählt.

        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. Wenn Sie sehen möchten, welche Logeinträge Ihrem Filter entsprechen, klicken Sie auf Vorschau von Logs.

      6. (Optional) Fügen Sie im Abschnitt Labels ein Label hinzu. Eine Anleitung zum Erstellen von Labels finden Sie unter Label erstellen.

      7. 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 projektbezogener logbasierter Messwert namens error_count 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 mit Bucket-Bereich 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 für logbasierte Messwerte konfigurieren.

      API

      Verwenden Sie zum Erstellen eines Zählermesswerts die Methode projects.metrics.create der Logging API. Wenn Sie den APIs Explorer-Bereich auf der Referenzseite verwenden, bereiten Sie die Argumente so vor:

      1. Geben Sie für das Feld parent das Projekt oder den Bucket an, in dem der Messwert erstellt werden soll:

        • Geben Sie für einen logbasierten Messwert mit Projektbereich das Projekt an:
        projects/PROJECT_ID
        • Geben Sie für einen logbasierten Messwert mit Bucket-Bereich den Bucket an:
        projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID

      2. Legen Sie für den Anfragetext ein LogMetric-Objekt fest. Im Folgenden finden 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, der innerhalb der logbasierten Messwerte in Ihrem Projekt einmalig ist. 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 von logbasierten Messwerten eine Einführung zu Labels sowie Einzelheiten zu ihrer Erstellung in der API.

      Weitere Informationen finden Sie unter LogMetric-Typ.

      Latenz neuer Messwerte

      Ihr neuer Messwert wird unmittelbar in der Messwertliste des Log-Explorers und in den relevanten Monitoring-Menüs 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

      1. Rufen Sie in der Google Cloud Console die Seite Logbasierte Messwerte auf:

        Zu Logbasierte Messwerte

        Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

      2. Im Bereich Benutzerdefinierte Messwerte werden die benutzerdefinierten logbasierten Messwerte im aktuellen Google Cloud Projekt angezeigt:

      3. Klicken Sie in der Zeile des Messwerts auf das Menü und wählen Sie In Metrics Explorer ansehen aus, um die Daten eines logbasierten Messwerts anzuzeigen.

      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 aus der Google Cloud CLI auslesen.

      API

      Messwerte auflisten

      Verwenden Sie zum Auflisten der benutzerdefinierten logbasierten Messwerte in einem Google Cloud -Projekt die API-Methode projects.metrics.list. 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 Seitentokens finden Sie unter projects.metrics.list.

      Messwertdefinitionen abrufen

      Verwenden Sie zum Abrufen eines einzelnen benutzerdefinierten logbasierten Messwerts die API-Methode projects.metrics.get. 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 die Methode projects.timeseries.list in der Cloud Monitoring API. Weitere Informationen zu Zeitachsendaten finden Sie unter Zeitachsen lesen.

      Wenn Sie einen einzelnen benutzerdefinierten logbasierten Messwert lesen möchten, geben Sie in die Parameter der Methode diesen Messwerttyp und diese Kennung ein:

      logging.googleapis.com/user/METRIC_ID

      Logbasierte Messwerte aktualisieren

      Sie können einen benutzerdefinierten logbasierten Messwert bearbeiten, um dessen Beschreibung, Filter und die Namen der im Messwert angegebenen 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 messwertbezogenen Messwert verwenden, können Sie auch den Bucket des Messwerts aktualisieren.

      Sie können die Namen oder Typen von benutzerdefinierten logbasierten Messwerten oder deren Labels nicht ändern und vorhandene Labels in einem logbasierten Messwert nicht löschen.

      So bearbeiten Sie einen logbasierten Messwert:

      Console

      1. Rufen Sie in der Google Cloud Console die Seite Logbasierte Messwerte auf:

        Zu Logbasierte Messwerte

        Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

      2. Klicken Sie im Menü für den logbasierten Messwert, den Sie ändern möchten, auf Messwert bearbeiten.

      3. Ändern Sie nur die zulässigen Elemente des Messwerts.

      4. Klicken Sie auf Messwert aktualisieren.

      gcloud

      Mit der Google Cloud CLI können Sie die Beschreibung, die Filterabfrage und den Bucket eines Zählermesswerts ändern. Sie können alle oder nur einige der Felder auf einmal aktualisieren.

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

      Wenn Sie den Bucket ändern, der einem Bucket-bezogenen Messwert zugeordnet ist, spiegeln alle Messwertdaten, die vor der Änderung erhoben wurden, nicht mehr die aktuelle Konfiguration wider. Die für den vorherigen Bucket erhobenen Messwertdaten werden nicht entfernt.

      Wenn Sie Verteilungsstatistiken oder andere Zählermesswertfelder mit Ausnahme von METRIC_NAME aktualisieren möchten, erstellen Sie eine Datei, die die überarbeitete Spezifikation Ihres LogMetric im JSON- oder YAML-Format enthält. Aktualisieren Sie dann die Messwertkonfiguration, 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

      1. Rufen Sie in der Google Cloud Console die Seite Logbasierte Messwerte auf:

        Zu Logbasierte Messwerte

        Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Logging ist.

      2. 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

      Rufen Sie mit folgendem Befehl weitere Details ab:

      gcloud logging metrics delete --help

      API

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

      Außerdem finden Sie in der Google Cloud Console auf der Seite Logbasierte Messwerte im Bereich Benutzerdefinierte Messwerte weitere Features, mit denen Sie die benutzerdefinierten Messwerte in IhremGoogle Cloud -Projekt verwalten können. Weitere Informationen finden Sie unter Benutzerdefinierte Messwerte.