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 können Ihnen den Einstieg erleichtern:

Auf den Code-Editor zugreifen

Sie können über die folgenden Seiten in der Google Cloud Console auf PromQL zugreifen:

  • Metrics Explorer
  • Beim Erstellen von Dashboards Widget hinzufügen

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 Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.

Code-Editor verwenden

Geben Sie Ihre Abfrage in das Textfeld ein und klicken Sie auf Abfrage ausführen, um den Codeeditor zu verwenden.

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 die Abfrage während der Eingabe automatisch ausgeführt wird. Diese Option ist jedoch 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.

  • Wenn sich der Cursor am Ende einer Abfrage befindet, die unvollständig ist, aber keine Fehler aufweist, wird im Editor ein gelbes Dreieck in der Steuerleiste angezeigt. Wenn noch Platz ist, wird auch der Text Incomplete query (Unvollständige Abfrage) angezeigt.

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

Außerdem gibt es eine Leiste zwischen dem Code-Editor und dem Diagrammbereich. Mit dieser Leiste können Sie die relativen Größen der beiden Regionen ändern.

Diagramme speichern

Wie Sie ein Diagramm speichern, hängt vom Kontext ab, in dem Sie das Diagramm erstellt haben:

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

Diagramme aus Metrics Explorer speichern

Im Codeeditor im Metrics Explorer können Sie Ihr Diagramm in einem benutzerdefinierten Dashboard speichern. 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 Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
  4. Geben Sie die Abfrage im Editor ein.

  5. Wenn die Option zur automatischen Ausführung für den Codeeditor nicht aktiviert ist, führen Sie die Abfrage aus, indem Sie vor dem Speichern des Diagramms auf Abfrage ausführen klicken. Standardmäßig speichern benutzerdefinierte Dashboards Ihre Änderungen regelmäßig. Wenn Sie Ihre Abfrage nicht zuerst ausführen, speichert der Code-Editor die zuletzt 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 gewünschte 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 Codeeditor nicht aktiviert ist, führen Sie die Abfrage aus, indem Sie vor dem Speichern des Diagramms auf Abfrage ausführen klicken. Standardmäßig speichern benutzerdefinierte Dashboards Ihre Änderungen regelmäßig. Wenn Sie Ihre Abfrage nicht zuerst ausführen, 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 auf Seitenebene. Diese Filter werden für PromQL-Diagramme in Ihren benutzerdefinierten Dashboards unterstützt.

Code-Editor beenden

Klicken Sie auf einen der anderen Auswahltabs, um den Codeeditor zu beenden, ohne die Abfrage zu speichern. Jeglicher Abfragetext im Editor wird verworfen, Sie haben jedoch die Möglichkeit, ihn in der Zwischenablage zu speichern.