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