Grafanaの設定

  • GitLabにバンドルされていたGrafanaはGitLab 16.0で非推奨となりました。
  • GitLabにバンドルされていたGrafanaはGitLab 16.3で削除されました。

Grafanaは時系列メトリクスをグラフやダッシュボードで可視化できるツールです。GitLabはPrometheusにパフォーマンスデータを書き込み、Grafanaはそのデータをクエリしてグラフを表示することができます。

caution
GitLabにバンドルされていたGrafanaはGitLab 16.0で非推奨となり、GitLab 16.3で削除されました。詳しくは非推奨ノートをご覧ください。

GitLabダッシュボードのインポート

デフォルトのダッシュボードセットをインポートして、情報の表示を始めることができます。GitLabはデフォルトのGrafanaダッシュボードセットを公開しています。それらを使うには

  1. リポジトリをクローンするか、ZIP ファイルか tarball をダウンロードしてください。
  2. 以下の手順に従って、各ダッシュボード JSON ファイルを個別にインポートしてください。

あるいは、すべてのダッシュボードをGrafanaインスタンスにインポートすることもできます。このプロセスの詳細については、GitLab Grafana dashboardsを参照してください。

GitLab UIとのインテグレーション

GitLab 12.1 で導入されました

Grafanaを設定した後、GitLabのサイドバーからアクセスするためのリンクを有効にすることができます:

  1. 左のサイドバーで、Search を選択するか、次のページに進んでください。
  2. Admin Areaを選択します。
  3. 左サイドバーで、[設定] > [メトリクスとプロファイリング]を選択し、[メトリクス - Grafana]を展開します。
  4. Add a link to Grafanaチェックボックスを選択します。
  5. Grafana URLを設定します。Grafana インスタンスの完全な URL を入力します。
  6. 変更を保存を選択します。

GitLab は管理エリアのMonitoring > Metrics Dashboard にリンクを表示します。

必要なスコープ

GitLab 13.10で導入されました

上記のプロセスでGrafanaをセットアップすると、管理エリアのApplications > GitLab Grafanaの画面にはスコープが表示されません。しかし、スコープはread_user 必須であり、アプリケーションに自動的に提供さ read_userれます。read_user を含めないread_user 以外のスコープを設定 read_userすると、OAuthプロバイダとしてGitLabを使ってサインインしようとしたときにこのエラーになります:

The requested scope is invalid, unknown, or malformed.

このエラーが表示された場合は、GitLab Grafanaの設定画面で以下のいずれかが真になっていることを確認してください:

  • スコープが表示されません。
  • read_user スコープは内部に含まれています。

バンドルされたGrafanaの非推奨

バンドルされたGrafanaは、GitLabメトリクスへのユーザーインターフェイスを提供するLinuxパッケージインストール用のオプションサービスでした。

LinuxパッケージインストールにバンドルされているGrafanaのバージョンはサポートされなくなりました。バンドルされたGrafanaを使用している場合は、Grafana Labsの新しいバージョンに切り替える必要があります。

新しいGrafanaインスタンスへの切り替え

バンドルされているGrafanaからGrafana Labsの新しいバージョンのGrafanaに切り替えるには:

  1. Grafana LabsからGrafanaのバージョンを設定します。
  2. バンドルされているGrafanaから既存のダッシュボードをエクスポートします。
  3. 新しい Grafana インスタンスで既存のダッシュボードをインポートします。
  4. 新しいGrafanaインスタンスを使用するようにGitLabを設定します。