- 環境選択
- ダッシュボードの選択
- ダッシュボードをお気に入りにマーク
- メトリクス・ダッシュボード設定の管理
- Chartコンテキストメニュー
- ダッシュボードの注釈
- カスタムダッシュボードに関連リンクを追加
- プロジェクトごとのカスタムダッシュボードの定義
- トラブルシューティング
メトリクスダッシュボードの使い方
環境選択
ダッシュボードの上にある環境ドロップダウンボックスはすべての環境のリストを表示します。 すべての環境を入力しながら検索し、探している環境を選択することができます。
ダッシュボードの選択
ダッシュボードの上にあるダッシュボードドロップダウンボックスには、プロジェクトで使用可能なすべてのダッシュボードのリストが表示されます。 すべてのダッシュボードを入力しながら検索し、目的のダッシュボードを選択することができます。
ダッシュボードをお気に入りにマーク
GitLab 13.0から導入されました。
ダッシュボードを表示しているときに、空のスターダッシュボード ボタンをクリックすると、ダッシュボードをお気に入りとしてマークすることができます。 スターが付いたダッシュボードは、固体のスターボタンが表示され、ダッシュボード選択リストの一番上に表示されます。
お気に入りリストからダッシュボードを削除するには、「ダッシュボードのスターを解除 {スター}」ボタンをクリックします。
メトリクス・ダッシュボード設定の管理
GitLab 13.2 で導入されました。
メトリクス・ダッシュボードの設定を管理します：
- プロジェクトのメンテナーまたは管理者権限を持つユーザーとしてサインインします。
- ダッシュボードのオペレーション>メトリクスに移動します。
-
ダッシュボードの右上にある{設定}メトリクス設定をクリックします：
Chartコンテキストメニュー
ダッシュボードの各パネルからは、パネルの右上にある More actionsドロップダウンボックスをクリックしてコンテキストメニューにアクセスし、チャートのデータに関連するアクションを実行することができます。
オプションは以下の通りです：
カスタムダッシュボードのソースファイルの表示と編集
GitLab 12.5で導入されました。
プロジェクトのカスタムダッシュボードを表示する場合、Edit dashboardボタンをクリックすると、元の.yml ファイルを表示できます。
パネルを拡大
GitLab 13.0から導入されました。
ビジュアライゼーションを拡大表示するには、 [その他のアクション] アイコンをクリックし、[パネルの拡大] を選択してパネルを拡大します。
メトリクス・ダッシュボードに戻るには、ブラウザのBackボタンをクリックするか、Esc キーを押します。
ログを見る
GitLab 12.8で導入されました。
ログを有効にしている場合は、ダッシュボードのチャートから右上のコンテキストメニューをクリックしてログを表示できます。
チャート下部のタイムラインズーム機能を使うと、ログは選択した時間範囲に絞り込まれます。
タイムラインズームとURL共有
GitLab 12.8で導入されました。
チャートの下にあるタイムラインズーム機能を使って、好きな日時を拡大表示することができます。 スライダーをクリックしてドラッグし、表示するデータの開始日や終了日を選択すると、GitLabは選択した開始時刻と終了時刻をURLに追加し、特定の時間枠をより簡単に共有することができます。
データをCSVでダウンロード
メトリクス・ダッシュボードのPrometheusチャートのデータはCSVでダウンロードできます。
ダッシュボードの注釈
ダッシュボードを表示している間、選択された時間範囲に割り当てられたアノテーション・エントリーが自動的に取得され、そのダッシュボード内のすべてのチャートに表示されます。 マウス・カーソルを合わせると、各アノテーションは、イベントの正確な時間やその説明を含む追加の詳細を表示します。
アノテーションは、メトリクスダッシュボードのアノテーションAPIにリクエストすることで作成できます。
保持ポリシー
GitLab 13.01 で導入されました。
古い注釈によるストレージ容量の過剰消費を避けるため、2週間以上前の期間に添付されたレコードは毎日削除されます。 この定期的なバックグラウンドジョブは、サーバーのローカル時間で午前1時に実行されます。
カスタムダッシュボードに関連リンクを追加
GitLab 13.1で導入されました。
ダッシュボードの YAML ファイルに関連リンクを追加することで、カスタムダッシュボードに他のダッシュボードや外部サービスへのリンクを埋め込むことができます。 関連リンクはダッシュボードと同じタブで開きます。 関連リンクはダッシュボードの以下の場所に表示できます：
- ダッシュボードの一番上のレベル
linksダッシュボードのプロパティとして。 - チャートのコンテキストメニューでは、パネルの
linksプロパティとして。
関連リンクは以下の属性を含むことができます：
-
urlリンク先のURLは必須です。 -
titleこの属性が設定されていない場合、リンクタイトルには完全な URL が使用されます。 -
typeオプション。grafanaに設定すると、ダッシュボードの時間範囲の値が Grafana の時間範囲フォーマットに変換され、urlに追加されます。
ダッシュボードの時間範囲は、URLパラメータとしてurl 。
次の例では、ダッシュボードに2つの関連リンク（GitLab.com とGitLab Documentation）を追加しています：
リンクの構文
links:
- title: GitLab.com
url: https://gitlab.com
- title: GitLab Documentation
url: https://docs.gitlab.com
- title: Public Grafana playground dashboard
url: https://play.grafana.org/d/000000012/grafana-play-home?orgId=1
type: grafana
プロジェクトごとのカスタムダッシュボードの定義
GitLab 12.1で導入されました。
デフォルトでは、すべてのプロジェクトにGitLab定義のPrometheusダッシュボードが含まれており、いくつかの主要メトリクスが含まれていますが、独自のカスタムダッシュボードを定義することもできます。
ゼロから新しいファイルを作成することも、GitLabで定義されたPrometheusダッシュボードを複製することもできます。
プロジェクトに新しいダッシュボードを追加します。
GitLab 13.2で導入されたUIオプションです。
プロジェクトの.gitlab/dashboards/ ディレクトリに新しい YAML ファイルを追加することで、カスタムダッシュボードを設定できます。ダッシュボードをプロジェクトのオペレーション> メトリクスページに表示するには、ファイルの拡張子が.ymlで、プロジェクトのデフォルトブランチに存在する必要があります。
GitLab ユーザーインターフェースから新しいダッシュボードを作成するには：
- メンテナーまたはオーナー権限を持つユーザーとして GitLab にサインインします。
- ダッシュボードのオペレーション>メトリクスに移動します。
- ダッシュボードの右上にある アクションメニューをクリックし、新規作成を選択します：
- モーダルウィンドウで［リポジトリを開く］をクリックし、コマンドラインから新しいダッシュボードを作成する手順に従ってください。
コマンドラインから新しいダッシュボードを作成するには：
-
リポジトリのルートディレクトリの下に
.gitlab/dashboards/prom_alerts.ymlを作成します。各 YAML ファイルは、ダッシュボードのレイアウトとデータ入力に使用する Prometheus クエリを定義します。 このダッシュボードの例では、1 つのエリアチャートを表示します：dashboard: 'Dashboard Title' panel_groups: - group: 'Group Title' panels: - type: area-chart title: "Chart Title" y_label: "Y-Axis" y_axis: format: number precision: 0 metrics: - id: my_metric_id query_range: 'http_requests_total' label: "Instance: {{instance}}, method: {{method}}" unit: "count" - ファイルを保存し、コミットしてリポジトリにプッシュします。 ファイルはデフォルトブランチに存在する必要があります。
- プロジェクトのオペレーション>メトリクスに移動し、ドロップダウンからカスタムダッシュボードを選択します。
.gitlab/dashboards のサブディレクトリの下にネストされた設定ファイルはサポートされておらず、UIでは利用できません。GitLab で定義されたダッシュボードの複製
GitLabで定義されたダッシュボードの完全なコピーを、それに追加された全てのカスタムメトリクスと一緒に保存することができます。 結果の.yml ファイルはカスタマイズすることができ、プロジェクトに合わせることができます。 ダッシュボード .ymlファイルをプロジェクトのデフォルトブランチに.yml 保存 .ymlするか、新しいブランチに.yml 保存するかを決めることが .ymlできます。
-
ダッシュボードのドロップダウンまたはアクションメニューの［ダッシュボードの複製］をクリックします。
注：複製できるのは GitLab で定義されたダッシュボードだけです。 -
ファイル名と新しいコミットのメッセージなどのその他の情報を入力し、複製をクリックします。
デフォルトブランチを選択すると、新しいダッシュボードがすぐに使用できるようになります。 別のブランチを選択した場合は、そのブランチをまずデフォルトブランチにマージする必要があります。
トラブルシューティング
マネージドPrometheusアプリの問題をトラブルシューティングする際、Prometheus UIを表示することはしばしば役に立ちます。
メトリクス・ダッシュボード・ページの “No data found “エラー
データが見つかりません」画面が表示され続ける場合は、以下の原因が考えられます：
- この環境へのデプロイは成功していません。
- Prometheusにこの環境のパフォーマンスデータがないか、メトリクスが正しくラベル付けされていません。 これをテストするには、Prometheusサーバーに接続し、
$CI_ENVIRONMENT_SLUGを環境名に置き換えてクエリを実行します。 - GitLabの定義済み共通メトリクスを再追加する必要があるかもしれません。 これは、インポート共通メトリクスのRakeタスクを実行することで行うことができます。
