PromQL のコードエディタを使用する

このページでは、PromQL に対してコードエディタを使用する方法について説明します。このエディタは Google Cloud コンソールで使用でき、有効な PromQL クエリを作成するための候補やその他のツールを提供します。

このページでは PromQL 言語については説明しません。PromQL に関することは、オープンソースドキュメントをご覧ください。導入として、以下のリソースが役に立ちます。

コードエディタにアクセスする

PromQL には、次に挙げる Google Cloud コンソールのページからアクセスできます。

Metrics Explorer の使用時にコードエディタを開くには、次の手順を行います。

Google Cloud コンソールで、[Metrics Explorer] ページに移動します。
Metrics Explorer に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] で [PromQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定を行うのと同じツールバーにあります。
クエリが完了したら、凡例を構成したり、データの表示方法を変更したりできます。詳しくは次のページをご覧ください。
- グラフの表示オプションを設定する
- 凡例を構成する

コードエディタを使用するには、テキストフィールドにクエリを入力して [Run Query] をクリックします。

クエリを入力すると、エディタに構文的に有効な完了のリストが表示されます。Control+Space を押すとオートコンプリートメニューを手動で表示できます。Escape を押すと非表示にできます。

オプションのリスト内を移動するには、矢印キーを使用します。Enter を押すと、選択した項目が挿入されます。

使用可能なすべての選択肢に共通のプレフィックスを挿入するには、Tab を押します。

エディタは、検索と置換の機能をサポートしています。クエリ内のキーワードを検索し、必要に応じて置換するには、Control+F（Mac では Command+F）を押します。次のスクリーンショットで、その機能を示します。

コードエディタは検索置換機能をサポートしています。

エディタの 2 つのコントロールで、クエリの操作方法が決定されます。

デフォルトでは、[Run Query] をクリックした場合にのみクエリが実行されます。エディタは、クエリの入力と同時にクエリを自動的に実行するように設定できますが、デフォルトではこのオプションが無効にされています。

自動実行オプションを有効にするには、[Auto-run] トグルを使用します。このオプションが有効になると、エディタは次のように動作します。

[Run Query] ボタンは表示されません。
入力時にエラーメッセージが継続して表示されます。
カーソルが、不完全ではあるもののエラーのないクエリの末尾にある場合は、エディタのコントロールバーに黄色の三角形が表示されます。表示スペースがある場合は、[不完全なクエリ] というテキストも表示されます。

エディタは、不完全なクエリの評価を試みません。

コードエディタとグラフ領域の間にはグラブバーもあります。このバーを使用して、2 つの領域の相対的なサイズを変更します。

グラフの保存方法は、グラフを作成したコンテキストによって異なります。

Metrics Explorer のコードエディタから、グラフをダッシュボードに保存することもできます。グラフを保存するには:

Google Cloud コンソールで、[Metrics Explorer] ページに移動します。
Metrics Explorer に移動

検索バーを使用してこのページを検索する場合は、小見出しが [Monitoring] である結果を選択します。
クエリビルダーペインのツールバーで、[MQL] または [PROMQL] という名前のボタンを選択します。
[言語] で [PromQL] が選択されていることを確認します。言語切り替えボタンは、クエリの書式設定を行うのと同じツールバーにあります。
エディタにクエリを入力します。
コードエディタの自動実行オプションを有効にしていない場合は、グラフを保存する前に [Run Query] をクリックしてクエリを実行します。デフォルトでは、カスタムダッシュボードは定期的に変更を保存します。最初にクエリを実行しない場合、コードエディタは最後に実行したクエリを保存します。
[Save Chart] をクリックします。
グラフの保存を続行するには:
1. グラフにわかりやすいタイトルを付けます。
2. 新しいグラフを表示する目的のダッシュボードを選択します。
3. ダイアログで [Save]をクリックします。

新しいグラフをダッシュボードに保存する手順は次のとおりです。

グラフにわかりやすいタイトルを付けます。
コードエディタの自動実行オプションを有効にしていない場合は、グラフを保存する前に [Run Query] をクリックしてクエリを実行します。デフォルトでは、カスタムダッシュボードは定期的に変更を保存します。最初にクエリを実行しない場合、コードエディタは最後に実行したクエリを保存します。
ダッシュボードで自動保存を有効にしていない場合は、[保存] をクリックします。

Google Cloud コンソールは、カスタムダッシュボードのページレベルのフィルタをサポートしています。これらのフィルタでは、カスタムダッシュボードの PromQL グラフがサポートされています。

クエリを保存せずにコードエディタを終了するには、他のセレクタタブのいずれかをクリックします。エディタ内のクエリテキストは破棄されますが、クリップボードへの保存を選択することも可能です。