視覚化に注釈を付ける

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

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

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

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

注釈は、リッチイベントでグラフ上のポイントをマークする方法を提供します。注釈にカーソルを合わせると、イベントの説明とイベントタグを取得できます。テキストフィールドには、より詳細な他のシステムへのリンクを含めることができます。

ネイティブ注釈

Grafana には、ネイティブ注釈ストアと、グラフパネルから直接、または HTTP API を介して注釈イベントを追加する機能があります。

注釈の追加

1. ダッシュボードで、[時系列] パネルをクリックします。コンテキストメニューが表示されます。

2. コンテキストメニューで、[注釈の追加] をクリックします。

3. 注釈の説明と、オプションでタグを追加します。

4. [保存] をクリックします。

または、注釈を追加するには、[時系列] パネル上で Ctrl+Click または Cmd+Click し、[注釈の追加] ポップアップが表示されます。

リージョン注釈の追加

1. ダッシュボードで、時系列パネル上で Ctrl+Click または Cmd+Click します。

2. コンテキストメニューで、[注釈の追加] をクリックします。

3. 注釈の説明と、オプションでタグを追加します。

4. [保存] をクリックします。

注釈の編集

1. ダッシュボードで、[時系列] パネルの注釈インジケータにカーソルを合わせます。

2. 注釈ツールチップの編集 (鉛筆) アイコンをクリックします。

3. 説明や、オプションでタグを変更します。

4. [保存] をクリックします。

注釈の削除

1. ダッシュボードで、[時系列] パネルの注釈インジケータにカーソルを合わせます。

2. 注釈ツールチップのごみ箱アイコンをクリックします。

ビルトインクエリクエリ

注釈を追加すると、それらは引き続き表示されます。これは、すべてのダッシュボードに存在する組み込みの注釈クエリが原因です。この注釈クエリは、現在のダッシュボードから発生するすべての注釈イベントを取得し、それらが作成されたパネルに表示されます。これには、アラート状態履歴の注釈が含まれます。[注釈] 設定 (ダッシュボードの歯車メニュー) を開き、Annotations & Alerts (Built-in) という名前のクエリを変更することで、注釈の取得と描画を停止できます。

[名前を付けて保存] 機能を使用してダッシュボードをコピーすると、新しいダッシュボード ID が取得されるため、ソースダッシュボードで作成された注釈はコピーに表示されなくなります。新しい [注釈クエリ] を追加し、タグでフィルタリングしても、注釈を表示できます。これは、ソースダッシュボードの注釈にフィルタリングするタグがある場合にのみ機能します。

タグによるクエリ

-- Grafana -- データソースを使用して [～でフィルタリング] を Tags に設定することで、ネイティブ注釈ストアから注釈を取得する新しいクエリを作成できます。

Grafana v8.1 以降のバージョンでは、既存のタグの先行入力もサポートされており、少なくとも 1 つのタグを提供します。

例えば、注釈クエリ名 outages を作成し、タグ outage を指定します。このクエリは、停止タグが付いたすべての注釈 (ダッシュボードまたは API 経由) を表示します。注釈クエリで複数のタグが定義されている場合、Grafana はすべてのタグに一致する注釈のみを表示します。動作を変更するには、Match any を有効にすると、Grafana は指定したタグのいずれかを含む注釈を表示します。

Grafana v5.3+ では、タグクエリでテンプレート変数を使用できます。したがって、さまざまなサービスの統計を表示するダッシュボードと、表示するサービスを指定するテンプレート変数がある場合は、注釈クエリで同じテンプレート変数を使用して、それらのサービスの注釈のみを表示できます。

その他のデータソースのクエリ

注釈イベントは、注釈クエリを介して取得されます。ダッシュボードに新しい注釈クエリを追加するには、ダッシュボード設定メニューを開き、[注釈] を選択します。これにより、ダッシュボードの注釈設定ビューが開きます。新しい注釈クエリを作成するには、[新規] ボタンをクリックします。

注釈クエリの名前を指定します。この名前は、このクエリから注釈イベントを表示または非表示にするトグル (チェックボックス) に付けられます。例えば、2 つの注釈クエリ(Deploys と Outages) があるとします。トグルを使用すると、表示する注釈を決定できます。

注釈クエリの詳細

注釈クエリオプションは、データソースごとに異なります。特定のデータソースの注釈の詳細については、特定の「データソース」トピックを参照してください。