Codeeditor für PromQL verwenden

Auf dieser Seite wird die Verwendung des Codeeditors für PromQL beschrieben. Der Editor ist in der Google Cloud Console verfügbar und bietet Vorschläge und andere Tools zum Erstellen gültiger PromQL-Abfragen.

Die PromQL-Sprache wird auf dieser Seite nicht behandelt. Informationen zu PromQL finden Sie in der Open-Source-Dokumentation. Die folgenden Ressourcen für den Einstieg:

Code-Editor aufrufen

Sie greifen über die folgenden Seiten der Google Cloud Console auf PromQL zu:

  • Metrics Explorer
  • Widget hinzufügen, wenn Sie Dashboards erstellen

So öffnen Sie den Code-Editor, wenn Sie den Metrics Explorer verwenden:

  1. Rufen Sie in der Google Cloud Console die Seite Metrics Explorer auf.

    Zum Metrics Explorer

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

  2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
  3. Prüfen Sie, ob PromQL in der Ein-/Aus-Schaltfläche PromQL ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.

  4. Nachdem Sie die Abfrage abgeschlossen haben, können Sie die Legende konfigurieren oder die werden die Daten angezeigt. Weitere Informationen finden Sie auf den folgenden Seiten:

Code-Editor verwenden

Um den Code-Editor zu verwenden, geben Sie Ihre Abfrage in das Textfeld ein Klicken Sie auf Abfrage ausführen.

Automatische Vervollständigung

Während Sie Ihre Abfrage eingeben, zeigt der Editor eine Liste mit syntaxaktisch gültigen Vervollständigungen an. Sie können das Menü zur automatischen Vervollständigung manuell aufrufen. Dazu drücken Sie Control+Space und schließen es mit Escape.

Verwenden Sie die Pfeiltasten, um durch die Liste der Optionen zu gehen. Durch Drücken von Enter wird die ausgewählte Auswahl eingefügt.

Um das Präfix für alle verfügbaren Optionen einzufügen, drücken Sie Tab.

Suchen und ersetzen

Der Editor unterstützt die Funktion „Suchen und Ersetzen“. Drücken Sie Control+F (oder Command+F für Mac), um Begriffe in Ihrer Abfrage zu finden und zu ersetzen. Der folgende Screenshot zeigt die Funktion:

eine Funktion zum Suchen und Ersetzen unterstützt.

Editor-Steuerelemente

Der Editor verfügt über zwei Steuerelemente, die festlegen, wie er mit Ihrer Abfrage interagiert.

Standardmäßig wird Ihre Abfrage nur ausgeführt, wenn Sie auf Abfrage ausführen klicken. Sie können den Editor so einrichten, dass Ihre Abfrage automatisch ausgeführt wird als bei der Eingabe, aber diese Option ist standardmäßig deaktiviert.

Über die Ein/Aus-Schaltfläche Automatisch ausführen können Sie die Option „Automatisch ausführen“ aktivieren. Wenn diese Option aktiviert ist, funktioniert der Editor so:

  • Die Schaltfläche Abfrage ausführen wird nicht angezeigt.
  • Während der Eingabe werden ständig Fehlermeldungen angezeigt.

  • Befindet sich der Cursor am Ende einer Abfrage, die unvollständig, aber fehlerfrei ist, wird im Editor ein gelbes Dreieck in der Steuerleiste angezeigt. Wenn es „Room“ ist, wird ebenfalls der Text Uncomplete query (Unvollständige Anfrage) angezeigt.

    Der Editor versucht nicht, unvollständige Abfragen zu bewerten.

Zwischen dem Code-Editor und dem Diagrammbereich befindet sich außerdem eine Ziehleiste. Mit dieser Leiste können Sie die relativen Größen der beiden Regionen ändern.

Diagramme speichern

Wie Sie ein Diagramm speichern, hängt davon ab, in welchem Kontext Sie es erstellt haben:

  • Im Metrics Explorer.
  • Beim Erstellen oder Bearbeiten eines benutzerdefinierten Dashboards

Diagramme aus dem Metrics Explorer speichern

Im Code-Editor im Metrics Explorer können Sie in ein benutzerdefiniertes Dashboard. So speichern Sie das Diagramm:

  1. Rufen Sie in der Google Cloud Console die Seite Metrics Explorer auf.

    Zum Metrics Explorer

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

  2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
  3. Prüfen Sie, ob PromQL in der Ein-/Aus-Schaltfläche PromQL ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
  4. Abfrage im Editor eingeben.

  5. Wenn die Option „Automatisch ausführen“ für den Code-Editor nicht aktiviert ist, führen Sie Ihre Abfrage aus, indem Sie auf Abfrage ausführen klicken, bevor Sie das Diagramm speichern. Bei benutzerdefinierten Dashboards werden Ihre Änderungen standardmäßig regelmäßig gespeichert. Wenn Sie die Abfrage nicht zuerst ausführen, speichert der Code-Editor die letzte ausgeführte Abfrage.

  6. Klicken Sie auf Diagramm speichern.

  7. So speichern Sie das Diagramm weiter:

    1. Geben Sie dem Diagramm einen aussagekräftigen Titel.
    2. Wählen Sie das Dashboard für das neue Diagramm aus.
    3. Klicken Sie im Dialogfeld auf Speichern.

Diagramme in einem benutzerdefinierten Dashboard speichern

So speichern Sie ein neues Diagramm in Ihrem Dashboard:

  1. Geben Sie dem Diagramm einen aussagekräftigen Titel.

  2. Wenn die Option zur automatischen Ausführung für den Code-Editor nicht aktiviert ist, führen Sie den folgenden Befehl aus: indem Sie auf Abfrage ausführen klicken, bevor Sie das Diagramm speichern. Standardmäßig speichern benutzerdefinierte Dashboards Ihre Änderungen regelmäßig. Wenn Sie nicht Ihre Abfrage zuerst speichern, speichert der Code-Editor die zuletzt ausgeführte Abfrage.

  3. Wenn die automatische Speicherung für Ihr Dashboard nicht aktiviert ist, klicken Sie auf Speichern.

Die Google Cloud Console unterstützt Filter für benutzerdefinierte Dashboards. Diese Filter werden für PromQL unterstützt Ihren benutzerdefinierten Dashboards Diagramme erstellen.

Code-Editor beenden

Wenn Sie den Code-Editor verlassen möchten, ohne die Abfrage zu speichern, klicken Sie auf einen der anderen Auswahl-Tabs. Jeglicher Abfragetext im Editor wird verworfen, Sie haben jedoch die Möglichkeit, ihn in der Zwischenablage zu speichern.