翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
このドキュメントのトピックは、Grafana バージョン 10.x をサポートする Grafana ワークスペース向けです。
Grafana バージョン 9.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 9 での作業」を参照してください。
Grafana バージョン 8.x をサポートする Grafana ワークスペースについては、「Grafana バージョン 8 での作業」を参照してください。
注釈は、リッチイベントで視覚化上のポイントをマークする方法を提供します。これらは、すべてのグラフパネル上に垂直線とアイコンとして視覚化されます。注釈にカーソルを合わせると、イベントの説明とイベントタグを取得できます。テキストフィールドには、より詳細な他のシステムへのリンクを含めることができます。
視覚化には 3 つの方法で注釈を付けることができます。
-
組み込みの注釈クエリを使用して、パネルで直接注釈を付ける。
-
Grafana HTTP API の使用。
-
ダッシュボード設定での注釈クエリの設定。
最初の 2 つのケースでは、新しい注釈を作成し、最後のケースでは、データソースから既存の注釈をクエリします。組み込みの注釈クエリもこれをサポートしています。
このセクションでは、1 番目と 3 番目のオプションについて説明します。Grafana HTTP API の使用については、「注釈 API」を参照してください。
注釈は、次の視覚化タイプでサポートされています。
-
時系列
-
状態タイムライン
-
ローソク足チャート
パネルで注釈を作成する
Grafana には、すべてのダッシュボードに存在する組み込みの注釈クエリを使用して、パネルから直接注釈イベントを追加する機能があります。この方法で作成した注釈は Grafana に保存されます。
パネルに直接注釈を追加するには：
-
ダッシュボードは既に保存されている必要があります。
-
ビルトインクエリクエリを有効にする必要があります。
注釈を追加するには
-
ダッシュボードで、注釈を追加するパネルを選択します。コンテキストメニューが表示されます。
-
コンテキストメニューで、[注釈の追加] を選択します。
-
（オプション) 注釈の説明とタグを追加します。
-
[保存] を選択します。
または、パネルを選択しながら Ctrl (ないしは Cmd) を押すと、[注釈の追加] のポップアップが表示されます。
リージョン注釈
視覚化でリージョンまたは期間をカバーする注釈を作成することもできます。
リージョン注釈を追加するには
-
ダッシュボードで
Ctrl(またはCmd) を押して、パネルの領域を選択します。 -
注釈の説明とタグを追加します (オプション）。
-
[保存] をクリックします。
注釈を編集するには
-
ダッシュボードで、パネルの注釈インジケータにカーソルを合わせます。
-
注釈ツールヒントで [編集] (鉛筆) アイコンを選択します。
-
説明やタグを変更します。
-
[保存] を選択します。
注釈を削除するには
-
ダッシュボードで、パネルの注釈インジケータにカーソルを合わせます。
-
注釈ツールヒントで [削除] (ゴミ箱) アイコンを選択します。
ダッシュボード設定を使用して注釈を取得する
ダッシュボード設定の [注釈] で、新しいクエリを追加して、組み込みのデータ注釈データソースを含む任意のデータソースを使用して注釈を取得できます。注釈クエリは、ダッシュボード全体のグラフでイベントマーカーとして視覚化できるイベントを返します。
新しい注釈クエリを追加するには
-
ダッシュボードヘッダーの [設定] (歯車) アイコンを選択して、設定メニューを開きます。
-
[注釈] を選択します。
-
[注釈クエリの追加] をクリックします。
-
クエリの名前を入力します。
この名前は、このクエリから注釈イベントを表示できるようにするトグル (チェックボックス) に付けられます。
-
注釈のデータソースを選択します。
また、[高度なデータソースピッカーを開く] を選択して、新しいデータソースの追加 (管理者のみ使用可能) など、その他のオプションを表示することもできます。
-
注釈クエリをすぐに使用しない場合は、[有効] チェックボックスをオフにします。
-
ダッシュボードに注釈クエリの切り替えを表示しない場合は、[非表示] チェックボックスを選択します。
-
イベントマーカーの色を選択します。
-
[表示対象] ドロップダウンで、次のいずれかのオプションを選択します。
-
[すべてのパネル] – 注釈は、注釈をサポートするすべてのパネルに表示されます。
-
[選択したパネル] – 注釈は、選択したすべてのパネルに表示されます。
-
[選択した対象を除くすべてのパネル] – 注釈は、選択したパネルを除くすべてのパネルに表示されます。
-
-
クエリを設定します。
注釈クエリオプションは、データソースごとに異なります。特定のデータソースの注釈の詳細については、「データソースに接続する」を参照してください。
ビルトインクエリクエリ
注釈を追加すると、それらは引き続き表示されます。これは、すべてのダッシュボードに存在する組み込みの注釈クエリが原因です。この注釈クエリは、Grafana に保存されている現在のダッシュボードから発生するすべての注釈イベントを取得し、それらが作成されたパネルに表示されます。これには、アラート状態履歴の注釈が含まれます。
デフォルトでは、組み込みの注釈クエリは Grafana の特殊なデータソースを使用し、手動注釈はこのデータソースでのみサポートされます。組み込みの注釈クエリで別のデータソースを使用できますが、自動注釈を作成できるのは、そのデータソースのクエリエディタのみです。
ダッシュボードに直接注釈を追加するには、このクエリを有効にする必要があります。
ビルトインクエリクエリが有効になっていることを確認するには
-
ダッシュボードヘッダーのダッシュボードの [設定] (歯車) アイコンを選択して、ダッシュボード設定メニューを開きます。
-
[注釈] を選択します。
-
[注釈とアラート (組み込み)] クエリを検索します。
クエリ名の前に [無効] と表示されている場合は、クエリ名を選択してクエリを開き、設定を更新する必要があります。
注釈の取得と描画を停止するには
-
ダッシュボードヘッダーのダッシュボードの [設定] (歯車) アイコンを選択して、ダッシュボード設定メニューを開きます。
-
[注釈] を選択します。
-
[注釈とアラート (組み込み)] クエリを検索します。
-
[有効] トグルを選択して、オフにします。
[名前を付けて保存] 機能を使用してダッシュボードをコピーすると、新しいダッシュボード ID が取得されるため、ソースダッシュボードで作成された注釈はコピーに表示されなくなります。新しい [注釈クエリ] を追加し、タグでフィルタリングしても、注釈を表示できます。ただし、これは、ソースダッシュボードの注釈にフィルタリングするタグがある場合にのみ機能します。
タグによるクエリのフィルタリング
[～でフィルタリング] を Tags に設定することで、Grafana データソースを使用して組み込みの注釈クエリから注釈を取得する新しいクエリを作成できます。
例えば、注釈クエリ名 outages を作成し、タグ outage を指定します。このクエリは、 outage タグを含むすべての注釈 (ダッシュボードまたは API 経由) を表示します。注釈クエリで複数のタグが定義されている場合、Grafana はすべてのタグに一致する注釈のみを表示します。動作を変更するには、[任意の一致] を有効にします。Grafana は、指定したタグのいずれかを含む注釈を表示します。
タグクエリでテンプレート変数を使用することもできます。つまり、さまざまなサービスの統計を表示するダッシュボードと、表示するサービスを指定するテンプレート変数がある場合は、注釈クエリで同じテンプレート変数を使用して、それらのサービスの注釈のみを表示できます。
