記録されたクエリ

このドキュメントトピックは、Grafana バージョン 8.x をサポートする Grafana ワークスペース向けに設計されています。

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

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

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

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

記録されたクエリの仕組み

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

• 単一行と列 - 単一の行と列を返すクエリ。

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

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

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

注記

記録されたクエリを使用する前に、Prometheus データソースを設定し、リモート書き込みターゲットに関連付ける必要があります。

記録されたクエリを作成する

記録されたクエリを作成するには、次のステップを実行します。

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

2. クエリエディタにあるレコードクエリメニューを選択します。

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

   • 名前 - 記録されたクエリの名前。

   • 説明 - (オプション) 記録されたクエリを、記録されたクエリリストに表示するとおりに記述します。

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

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

   • クエリ結果のカウント - クエリから返された行をカウントする場合は、このオプションをオンに切り替えます。このオプションがオフの場合、クエリは 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 データソースを選択し、リモート書き込みパスを入力します。