Verteilungsmesswerte konfigurieren

Console

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

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 Verteilung 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 Ihres Google Cloud-Projekts 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: (optional) Für Verteilungsmesswerte können Sie optional Einheiten wie s und ms eingeben. Weitere Informationen finden Sie im Feld unit des MetricDescriptor.

5. Definieren Sie den Messwertfilter im Abschnitt Filterauswahl.

   1. Wählen Sie im Menü Projekt oder Log-Bucket auswählen aus, 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. Feldname: Geben Sie das Feld des Logeintrags ein, das den Wert der Verteilung enthält. Bei der Eingabe werden Optionen zur Auswahl angezeigt. Beispiel:

      protoPayload.latency
      

   4. Regulärer Ausdruck: (optional) Wenn Feldname immer einen numerischen Wert enthält, der in den Typ double umgewandelt werden kann, können Sie dieses Feld leer lassen. Geben Sie andernfalls einen regulären Ausdruck an, mit dem der numerische Verteilungswert aus dem Feldwert extrahiert wird.

      Beispiel: Angenommen, das Logeintragsfeld latency enthält eine Zahl gefolgt von ms für Millisekunden. Mit dem folgenden regulären Ausdruck wird die Zahl ohne die nachstehende Einheit ausgewählt:

      ([0-9.]+)
      

      Die Klammern kennzeichnen die Erfassungsgruppe für reguläre Ausdrücke, d. h. den zu extrahierenden Teil des übereinstimmenden Texts. Weitere Informationen finden Sie unter Reguläre Ausdrücke verwenden.

   • Erweitert (Histogramm-Buckets): (Optional) Durch Klicken auf Erweitert wird ein Abschnitt des Formulars geöffnet, in dem Sie benutzerdefinierte Bucket-Layouts angeben können. Wenn Sie keine Bucket-Layouts angeben, wird ein Standard-Bucket-Layout verwendet. Weitere Informationen finden Sie auf dieser Seite unter Histogramm-Buckets.
   1. Klicken Sie auf Logvorschau ansehen, um zu sehen, welche Logeinträge Ihrem Filter entsprechen.

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

Wenn Sie einen logbasierten Messwert vom Typ „Verteilung“ erstellen möchten, erstellen Sie eine Datei, die eine Darstellung Ihrer LogMetric-Definition im JSON- oder YAML-Format enthält. Verwenden Sie dann den folgenden Befehl, um die Konfiguration aus der Datei zu lesen:

gcloud logging metrics create METRIC_NAME --config-from-file FILENAME

Informationen zum Beschreiben der Histogramm-Buckets für eine Verteilung finden Sie unter Histogramm-Buckets.

API

Verwenden Sie zum Erstellen eines Verteilungsmesswerts die Methode projects.metrics.create der Logging API. Wenn Sie den Bereich „APIs Explorer“ 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 auf Projektebene das Projekt an:

   projects/PROJECT_ID
   

   • Geben Sie für einen logbasierten Messwert auf Bucketebene den Bucket an:

   projects/PROJECT_ID/locations/LOCATION/bucket/BUCKET_ID
   

2. Legen Sie für den Anfragetext ein LogMetric-Objekt fest. Im folgenden Beispiel wird ein Beispielobjekt für einen Verteilungsmesswert festgelegt.

   {
     name:        "my-metric"
     description: "Description of my-metric."
     filter:      "resource.type=gce_instance AND log_id(\"syslog\")",
     valueExtractor: "REGEXP_EXTRACT(jsonPayload.latencyField, \"([0-9.]+)ms\")",
   
     labelExtractors: {
       "my-label-1":
         "REGEXP_EXTRACT(jsonPayload.someField, \"before ([[:word:]]+) after\")",
       "my-label-2":
         "EXTRACT(jsonPayload.anotherField, \"before ([0-9]+) after\")",
     },
     bucketOptions: { [SEE_BELOW] },
   
     metricDescriptor: {
         metricKind: DELTA,
         valueType: DISTRIBUTION,
         unit: "ms",
   
         labels: [
           {
             key: "my-label-1",
             valueType: STRING,
             description: "Description of string my-label-1.",
           },
           {
             key: "my-label-2",
             valueType: INT64,
             description: "Description of integer my-label-2.",
           }
         ]
     },
   }
   

Hinweise:

• Für die Benennung gelten einige Einschränkungen. Weitere Informationen dazu finden Sie unter Fehlerbehebung.

• metricDescriptor: ein MetricDescriptor-Objekt. metricKind muss DELTA sein. valueType muss DISTRIBUTION sein.

Console

Das Untermenü Histogramm-Buckets wird geöffnet, wenn Sie einen Verteilungsmesswert erstellen und im Formular Messwert-Editor auf Mehr klicken. Das folgende Unterformular ist für das Bucket-Layout vom Typ Linear:

Lineare Buckets: Füllen Sie das Histogramm-Bucket-Formular so aus:

• Typ: Linear
• Start value (Startwert) (a): Der untere Grenzwert des ersten endlichen Buckets. Dieser Wert wird in der API als Versatz bezeichnet.
• Number of buckets (Anzahl der Buckets) (N): Die Anzahl der endlichen Buckets. Der Wert muss größer oder gleich 0 sein.
• Bucket width (Bucket-Breite) (b): Die Differenz zwischen der Ober- und Untergrenze jedes endlichen Buckets. Der Wert muss größer als 0 sein.

Angenommen, der Startwert ist 5, es sind insgesamt vier Buckets vorhanden und diese haben eine Breite von 15. Dadurch ergeben sich die folgenden Bucket-Bereiche:

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Explizite Buckets: Füllen Sie das Histogramm-Bucket-Formular wie folgt aus:

• Typ: Explizit
• Grenzwerte (b): Eine durch Kommas getrennte Liste der Grenzwerte der endlichen Buckets. Damit wird auch die Anzahl der Buckets und deren Breite bestimmt.

Beispiel: Die Liste der Grenzwerte lautet so:

0, 1, 2, 5, 10, 20

In diesem Fall sind fünf endliche Buckets mit folgenden Bereichen vorhanden:

(-INF, 0), [0, 1), [1, 2), [2,5), [5, 10), [10, 20), [20, +INF)

Exponentielle Buckets: Füllen Sie das Histogramm-Bucket-Formular so aus:

• Type (Typ): Exponentiell

• Number of buckets (Anzahl der Buckets) (N): Die Gesamtzahl der endlichen Buckets. Der Wert muss größer als 0 sein.

• Linear scale (Lineare Skala) (a): Die lineare Skala für die Buckets. Der Wert muss größer als 0 sein.

• Exponential growth factor (Faktor für exponentielles Wachstum) (b): Der Faktor für exponentielles Wachstum für die Buckets. Der Wert muss größer als 1 sein.

Beispiel: Wenn N=4, a=3 und b=2, gelten die folgenden Bucket-Bereiche:

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

Weitere Informationen zu den Buckets finden Sie unter BucketOptions in der Cloud Monitoring API.

API

Das optionale Bucket-Layout wird über das Feld bucketOptions im LogMetric-Objekt festgelegt, das für projects.metrics.create bereitgestellt wird. Das vollständige LogMetric-Objekt finden Sie auf dieser Seite unter Verteilungsmesswert erstellen. Die Zusätze für Bucket-Layouts sind unten dargestellt:

Lineare Buckets:

{ # LogMetric object
  ...
  bucketOptions: {
    linearBuckets: {
      numFiniteBuckets: 4,
      width: 15,
      offset: 5
    }
  },
  ...
}

Mit dem vorangegangenen Beispiel werden folgende Buckets erstellt:

(-INF, 5), [5, 20), [20, 35), [35, 50), [50, 65), [65, +INF)

Explizite Buckets: Die Grenzwerte werden einzeln aufgelistet.

{ # LogMetric object
  ...
  bucketOptions: {
    explicitBuckets: {
      bounds: [0, 1, 2, 5, 10, 20 ]
    }
  },
  ...
}

Mit dem vorangegangenen Beispiel werden folgende Buckets erstellt:

(-INF, 0), [0, 1), [1, 2), [2, 5), [5, 10), [10, 20), [20, +INF)

Exponentielle Buckets: Die Grenzwerte sind scale * growthFactor ^ i, wobei i = 0, 1, 2, ..., numFiniteBuckets ist.

{ # LogMetric object
  ...
  bucketOptions: {
    exponentialBuckets: {
      numFiniteBuckets: 4,
      growthFactor: 2,
      scale: 3
    }
  },
  ...
}

Mit dem vorangegangenen Beispiel werden folgende Buckets erstellt:

(-INF, 3), [3, 6), [6, 12), [12, 24), [24, 48), [48, +INF)

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 more_vert Dreipunkt-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 aus 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 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: 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

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 more_vert 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

Verwenden Sie die Google Cloud CLI, um die Beschreibung, die Filterabfrage und den Bucket eines Zählermesswerts zu ändern. Sie können alle oder einzelne 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, spiegeln die vor der Änderung erhobenen Messwertdaten nicht mehr die aktuelle Konfiguration wider. Die für den vorherigen Bucket erfassten Messdaten werden nicht entfernt.

Wenn Sie Verteilungsmesswerte oder andere Zählermesswerte (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 Werte für die folgenden Felder 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.

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