記録済みのクエリ

このドキュメントのトピックは、Grafana バージョン 8.x をサポートする Grafana ワークスペース向けです。

Grafana バージョン 10.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 10 での作業」を参照してください。

Grafana バージョン 9.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 9 での作業」を参照してください。

記録済みのクエリを使用して設定間隔でデータポイントのスナップショットを撮ると、時間の経過に伴う傾向を確認できます。これにより過去の傾向を把握できます。

時系列を返さないプラグインの場合は、履歴データをプロットすると便利な場合があります。例えば、[ServiceNow] をクエリするとリクエスト応答時間の履歴を表示できますが、現在時点のメトリクスのみを返すことができます。

記録済みのクエリの仕組み

記録済みのクエリは、バックエンドデータソースプラグインでのみ機能します。詳細については、「バックエンドデータソースプラグイン」を参照してください。次の 3 つのタイプのクエリを記録できます。

• 単一の行および列 - 単一の行および列を返すクエリ。

• 行カウント - カウントする意味のある行を返すクエリ。

• 式 - 任意の式。式の作成および使用の詳細については、「式」を参照してください。

記録済みのクエリを作成または有効にすると、すぐにスナップショットが作成され、設定間隔でスナップショットが引き続き作成されます。記録済みのクエリでは、スナップショットが無効化、削除された場合、または Grafana が実行されていない場合、スナップショットの作成が停止します。記録済みのクエリを実行し、各結果をリモート書き込み対応の Prometheus インスタンスに転送すると、データポイントはバックエンドに収集されます。

注記

記録済みのクエリを使用するには、Prometheus データソースを設定してリモート書き込み先に関連付ける必要があります。

記録済みのクエリの作成

記録済みのクエリを作成するには、次の手順を実行します。

1. 編集パネルでダッシュボードに記録するクエリを検索または作成します。クエリは単一の行と列のみを返す必要があります。さらに多く返される場合、カウントオプションを使用して、返される結果の数を記録できます。クエリのデータソースは、バックエンドデータソースである必要があります。式は時系列クエリからのデータ集約に使用できます。式の作成および使用の詳細については、「式」を参照してください。

2. クエリエディタで [レコードクエリ] メニューを選択します。

3. 記録済みのクエリの情報を入力します。特に指示されていない限り、すべてのフィールドは必須です。

   • 名前 - 記録済みのクエリの名前。

   • 説明 - (オプション) 記録済みのクエリのリストに表示する、記録済みのクエリに関する説明を記述します。

   • 間隔 - スナップショットが取得される間隔です。間隔は、記録済みのクエリの作成時に開始され、記録済みのクエリを一時停止または削除すると停止します。記録済みのクエリの一時停止と削除の詳細については、「記録済みのクエリの管理」を参照してください。

   • 範囲 - クエリの相対時間範囲です。30m の範囲と 1h の間隔を選択すると、クエリは過去 30 分の 1 時間ごとのスナップショットを取得します。

   • クエリ結果のカウント - クエリが返した行をカウントする場合は、このオプションをオンに切り替えます。このオプションがオフの場合、クエリは 1 つの値を持つ 1 行を返します。

4. [記録済みのクエリのテスト] ボタンを選択して、記録済みのクエリをテストします。

5. [記録の開始] を選択します。

記録済みのクエリの追加

ダッシュボードで、既存の記録済みのクエリをパネルに追加できます。記録済みのクエリを追加するたび、Prometheus クエリ generated_recorded_query_name{id="generated_id", name="recorded query name"} が作成されます。Prometheus から作成されたクエリは、記録済みのクエリすべてが収集されたスナップショットを返します。

1. 記録済みのクエリを追加するダッシュボードのパネルに移動します。

2. [+ 記録済みのクエリ] メニューを選択します。

3. データソースにより記録済みのクエリをフィルタリングする場合は、データソースドロップダウンメニューで、フィルターのデータソースを選択します。

4. 記録済みのクエリで [追加] メニューを選択して、パネルに追加します。

記録済みのクエリをパネルに追加すると、パネルデータソースは -- Mixed -- になります。記録済みのクエリは、記録済みのクエリの名前と一致する名前ラベルが付いた Prometheus クエリで表されます。Prometheus データソースの詳細については、「Prometheus」を参照してください。

記録済みのクエリを追加した後、Prometheus データソースではなく -- Mixed -- データソースを持つクエリが表示される場合は、記録済みのクエリに対して Prometheus リモート書き込み先が設定されていない可能性があります。「リモート書き込み先」を参照して、リモート書き込みポイントをセットアップしてください。

記録済みのクエリの使用

記録済みのクエリを使用するには、クエリを作成してダッシュボードに追加します。その後、[記録済みのクエリ] タブの [設定] で管理できます。

記録済みのクエリの管理

記録済みのクエリを一時停止またはアクティブ化すると、設定の [記録済みのクエリ] タブから削除できます。記録済みのクエリを削除すると Grafana から削除されますが、Prometheus で収集された情報はそこに残ります。記録済みのクエリを一時停止すると、再開されるまで新しいデータポイントが収集されなくなります。

リモート書き込み先

リモート書き込み先は、記録済みのクエリデータポイントが書き込まれる [Prometheus] データソースです。リモート書き込みが有効な Prometheus が必要で、この Prometheus のデータソースを作成する必要があります。

リモート書き込み先を編集するには、[設定] の [記録済みのクエリ] タブのコンソールメニューで、[リモート書き込み先の編集] を選択します。リモート書き込みが有効な [Prometheus] データソースを選択して、リモート書き込みパスを入力します。