分析ダッシュボード

分析ダッシュボードを使用すると、収集されたデータを組み込みのダッシュボードで視覚化できます。

ダッシュボードの拡張されたエクスペリエンスは、エピック13801で提案されています。

データソース

データソースとは、ダッシュボードのフィルターとビジュアライゼーションが結果をクエリして取得するために使用できる、データベースまたはデータのコレクションへの接続です。

組み込みダッシュボード

分析をすぐに開始できるように、GitLabには事前定義されたビジュアライゼーションを備えた組み込みダッシュボードが用意されています。これらのダッシュボードには、By GitLab（By GitLab）というラベルが付けられています。組み込みダッシュボードを編集することはできませんが、同様のスタイルでカスタムダッシュボードを作成できます。

次の組み込みダッシュボードを使用できます:

• バリューストリームダッシュボードは、DevOpsのパフォーマンス、セキュリティの露出、ワークストリームの最適化に関連するメトリクスを表示します。
• GitLab Duo and SDLC trends（GitLab DuoとSDLCのトレンド）は、プロジェクトまたはグループのソフトウェア開発ライフサイクル（SDLC）メトリクスに対するAIツールの影響を表示します。
• DORA Metrics Dashboard（DORAメトリクスダッシュボード）は、各DORAメトリクスの時間的変化を表示します。
• マージリクエスト分析は、マージリクエストのスループットとマージまでの平均時間のメトリクスを表示します。

カスタムダッシュボード

お客様のケースに最も関連性の高いメトリクスを視覚化するために、カスタムダッシュボードを作成することができます。

• 各プロジェクトには、無制限の数のダッシュボードを設定できます。唯一の制限は、リポジトリサイズの制限である可能性があります。
• 各ダッシュボードは、1つ以上のビジュアライゼーションを参照できます。
• ビジュアライゼーションは、ダッシュボード間で共有できます。

プロジェクトのメンテナーは、コードオーナーや承認ルールなどの機能を使用して、ダッシュボードの変更に対する承認ルールを適用できます。ダッシュボードファイルは、プロジェクトのコードの残りの部分とともに、ソース管理でバージョニングされます。

プロジェクトダッシュボードを表示

前提要件:

• プロジェクトのレポーターロール以上が必要です。

プロジェクトのダッシュボード（組み込みとカスタムの両方）のリストを表示するには、次の手順に従います:

1. 左側のサイドバーで、検索または移動先を選択して、プロジェクトを見つけます。
2. 左側のサイドバーで、分析 > 分析ダッシュボードを選択します。
3. 利用可能なダッシュボードのリストから、表示するダッシュボードを選択します。

グループダッシュボードを表示

前提要件:

• グループのレポーターロール以上が必要です。

グループのダッシュボード（組み込みとカスタムの両方）のリストを表示するには、次の手順に従います:

1. 左側のサイドバーで、検索または移動先を選択して、グループを見つけます。
2. 左側のサイドバーで、分析 > 分析ダッシュボードを選択します。
3. 利用可能なダッシュボードのリストから、表示するダッシュボードを選択します。

ダッシュボードの場所を変更

プロジェクトまたはグループのカスタムダッシュボードの場所を変更できます。

前提要件:

• ダッシュボードが属するプロジェクトまたはグループに対してメンテナーロール以上を持っている必要があります。

グループダッシュボード

グループのカスタムダッシュボードの場所を変更するには、次の手順に従います:

1. 左側のサイドバーで、検索または移動先を選択し、ダッシュボードファイルを保存するプロジェクトを見つけます。そのプロジェクトは、ダッシュボードを作成するグループに属している必要があります。
2. 左側のサイドバーで、検索または移動先を選択して、グループを見つけます。
3. 設定 > 分析を選択します。
4. 分析ダッシュボードセクションで、ダッシュボードファイルプロジェクトを選択します。
5. 変更を保存を選択します。

プロジェクトダッシュボード

デフォルトでは、カスタムダッシュボードは現在のプロジェクトに保存されます。これは、ダッシュボードが通常、分析データの取得元となるプロジェクトで定義されるためです。ただし、ダッシュボード用に別のプロジェクトを用意することもできます。このセットアップは、ダッシュボード定義に特定のアクセスルールを適用したり、複数のプロジェクト間でダッシュボードを共有したりする場合に推奨されます。

プロジェクトのダッシュボードの場所を変更するには、次の手順に従います:

1. 左側のサイドバーで、検索または移動先を選択してプロジェクトを見つけるか、新規作成（ ）と新規プロジェクト/リポジトリを選択して、ダッシュボードファイルを保存するプロジェクトを作成します。
2. 左側のサイドバーで、検索または移動先を選択して、分析プロジェクトを見つけます。
3. 設定 > 分析を選択します。
4. 分析ダッシュボードセクションで、ダッシュボードファイルプロジェクトを選択します。
5. 変更を保存を選択します。

構成によるダッシュボードの作成

設定でダッシュボードを手動で作成できます。

ダッシュボードを定義するには:

1. .gitlab/analytics/dashboards/で、ダッシュボードのように名前を付けたディレクトリを作成します。

   各ダッシュボードには、独自のディレクトリが必要です。

2. 新しいディレクトリに、.yamlファイルを作成します（例：.gitlab/analytics/dashboards/my_dashboard/my_dashboard.yaml）。

   このファイルには、ダッシュボードの定義が含まれています。これは、ee/app/validators/json_schemas/analytics_dashboard.jsonで定義されたJSONスキーマに準拠している必要があります。

3. オプション。ダッシュボードに追加する新しいビジュアライゼーションを作成するには、チャートビジュアライゼーションテンプレートの定義を参照してください。

たとえば、3つのダッシュボードと、すべてのダッシュボードに適用される1つのビジュアライゼーション（折れ線チャート）を作成する場合、ファイル構造は次のようになります:

.gitlab/analytics/dashboards
├── conversion_funnels
│  └── conversion_funnels.yaml
├── demographic_breakdown
│  └── demographic_breakdown.yaml
├── north_star_metrics
|  └── north_star_metrics.yaml
├── visualizations
│  └── example_line_chart.yaml

ダッシュボードフィルター

ダッシュボードは、次のフィルターをサポートしています:

• 日付範囲: データを日付でフィルターするための日付セレクター。
• Anonymous users（匿名ユーザー）: データセットから匿名ユーザーを含めるか除外する切り替え。

フィルターを有効にするには、.yaml設定ファイルで、フィルターのenabledオプションをtrueに設定します:

title: My dashboard
# ...
filters:
  excludeAnonymousUsers:
    enabled: true
  dateRange:
    enabled: true

完全なダッシュボード設定の例をご覧ください。

インラインのチャートビジュアライゼーションを定義する

さまざまなチャートを定義し、次のようなビジュアライゼーションオプションをいくつか追加できます:

• EChartsドキュメントにリストされているオプションを含む折れ線チャート。

• EChartsドキュメントにリストされているオプションを含む縦棒チャート。

• データテーブル。

• 単一の統計。設定する唯一のオプションは、decimalPlacesです（数値、デフォルト値は0）。このプロセスは、ユーザーが作成したダッシュボードでも実行できます。各ビジュアライゼーションは、次の必須フィールドで記述する必要があります:

• バージョン

• タイプ:

• データ:

• オプション:

チャートのビジュアライゼーションテンプレートを定義する

複数のダッシュボードで使用するビジュアライゼーションが必要な場合は、それらを個別のテンプレートファイルとして保存できます。ダッシュボードに追加すると、ビジュアライゼーションテンプレートがダッシュボードにコピーされます。ダッシュボードにコピーされたビジュアライゼーションテンプレートは、ビジュアライゼーションテンプレートが更新されても更新されません。

ダッシュボードのチャートビジュアライゼーションテンプレートを定義するには:

1. .gitlab/analytics/dashboards/visualizations/ディレクトリに、.yamlファイルを作成します。ファイル名は、定義するビジュアライゼーションを説明するものである必要があります。
2. .yamlファイルで、ee/app/validators/json_schemas/analytics_visualization.jsonのスキーマに従って、ビジュアライゼーション設定を定義します。

たとえば、時間の経過に伴うイベント数を説明する折れ線チャートを作成するには、visualizationsフォルダーで、次の必須フィールドを含むline_chart.yamlファイルを作成します:

• バージョン
• タイプ:
• データ:
• オプション:

トラブルシューティング

Something went wrong while loading the dashboard.

ダッシュボードにデータを読み込むことができなかったというグローバルエラーメッセージが表示された場合は、最初にページをリロードしてみてください。エラーが解決しない場合:

• お客様の設定が、ee/app/validators/json_schemas/analytics_dashboard.jsonで定義されているダッシュボードJSONスキーマと一致していることを確認してください。

Invalid dashboard configuration

ダッシュボードに設定が無効であるというグローバルエラーメッセージが表示された場合は、お客様の設定が、ee/app/validators/json_schemas/analytics_dashboard.jsonで定義されているダッシュボードJSONスキーマと一致していることを確認してください。

Invalid visualization configuration

ダッシュボードパネルに、ビジュアライゼーション設定が無効であるというメッセージが表示された場合は、お客様のビジュアライゼーション設定が、ee/app/validators/json_schemas/analytics_visualization.jsonで定義されているビジュアライゼーションJSONスキーマと一致していることを確認してください。

ダッシュボードパネルエラー

ダッシュボードパネルにエラーメッセージが表示された場合:

• ビジュアライゼーション設定が正しく設定されていることを確認してください。