- データソース
- 組み込みダッシュボード
- カスタムダッシュボード
- ダッシュボードデザイナー
- プロジェクトダッシュボードの表示
- ダッシュボードの場所の変更
- ダッシュボードの定義
- チャート視覚化の定義
- カスタムダッシュボードの作成
- カスタムダッシュボードの編集
- トラブルシューティング
分析ダッシュボード（ULTIMATE ALL EXPERIMENT）
GitLab 15.9で、
combined_analytics_dashboardsというフラグを持つ Experiment機能として導入されました。デフォルトでは無効になっています。
フラグ: セルフマネジメントのGitLabでは、デフォルトではこの機能は利用できません。プロジェクトごと、またはインスタンス全体で利用できるようにするには、管理者がcombined_analytics_dashboards という機能フラグを有効にします。GitLab.comでは、この機能は利用できません。この機能はまだ本番環境では使用できません。
Analyticsダッシュボードは、収集したデータを視覚化するのに役立ちます。ビルトインのダッシュボードを使用することも、カスタムビジュアライゼーションで独自のダッシュボードを作成することもできます。
データソース
データソースとは、ダッシュボードのフィルタやビジュアライゼーションでクエリや結果の取得に使用できる、データベースやデータのコレクションへの接続です。
分析ダッシュボードには、以下のデータソースが設定されています：
組み込みダッシュボード
アナリティクスを始めるために、GitLabは定義済みのビジュアライゼーションを備えたビルトインダッシュボードを提供しています。
商品分析
- Audienceは、ユーザー数やセッション数など、トラフィックに関するメトリクスを表示します。
- Behaviorは、ページビュー数やイベント数など、ユーザーのアクティビティに関するメトリクスを表示します。
これらのダッシュボードはBy GitLab と表示され、編集することはできません。代わりに、同じようなスタイルのカスタムダッシュボードを作成することができます。
バリューストリームマネジメント
- バリューストリームダッシュボードには、DevOps パフォーマンス、セキュリティの露出、ワークストリームの最適化に関するメトリクスが表示されます。
カスタムダッシュボード
カスタム・ダッシュボードを使用すると、ユースケースに最も関連性の高いメトリクスを設計して視覚化できます。カスタム・ダッシュボードは、ダッシュボード・デザイナーで作成できます。
- 各プロジェクトは、無制限の数のダッシュボードを持つことができます。唯一の制限はリポジトリサイズの制限です。
- 各ダッシュボードは、1 つまたは複数のビジュアライゼーションを参照できます。
- ビジュアライゼーションはダッシュボード間で共有されます。
プロジェクトのメンテナーは、コードオーナーや 承認ルールなどの機能を使って、ダッシュボードの変更に承認ルールを適用できます。ダッシュボードのファイルは、プロジェクトの他のコードと一緒にソース管理でバージョン管理されます。
ダッシュボードデザイナー
GitLab 16.1 で
combined_analytics_dashboards_editorというフラグで導入されました。デフォルトでは無効になっています。
フラグ: セルフマネジメントのGitLabでは、デフォルトではこの機能は利用できません。プロジェクトごと、またはインスタンス全体で利用できるようにするには、管理者がcombined_analytics_dashboards_editor という機能フラグを有効にします。GitLab.comでは、この機能は利用できません。この機能はまだ本番環境では使用できません。
product_analytics_snowplow_support 機能フラグとは併用できません。ダッシュボード・デザイナーを使用すると、以下のことができます：
- カスタムダッシュボードの作成
- カスタムダッシュボードの名前を変更します。
- 新規および既存のカスタムダッシュボードにビジュアライゼーションを追加します。
- カスタムダッシュボードのパネルのサイズ変更や移動。
プロジェクトダッシュボードの表示
前提条件
- 少なくともプロジェクトの開発者ロールを持っている必要があります。
プロジェクトのダッシュボード（組み込みとカスタムの両方）のリストを表示するには、以下の手順に従います：
- 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
- 分析 > 分析ダッシュボードを選択します。
- 利用可能なダッシュボードのリストから、表示するダッシュボードを選択します。
ダッシュボードの場所の変更
プロジェクトまたはグループのダッシュボードの場所を変更できます。
グループダッシュボード
グループのダッシュボードの場所を変更するには：
- 左側のサイドバーで、[検索] または [移動]を選択し、ダッシュボード ファイルを保存するプロジェクトを見つけます。プロジェクトは、ダッシュボードを作成するグループに属している必要があります。
- 左のサイドバーで、Search（検索）を選択するか、Go to（移動）を選択してグループを探します。
- 設定] > [全般]を選択します。
- アナリティクス]を展開します。
- Analytics Dashboards] セクションで、ダッシュボード ファイル プロジェクトを選択します。
- 変更を保存を選択します。
プロジェクトダッシュボード
ダッシュボードは通常、分析データを取得するプロジェクトで定義します。しかし、ダッシュボード用に別のプロジェクトを持つこともできます。これは、ダッシュボードの定義に特定のアクセスルールを適用したり、複数のプロジェクトでダッシュボードを共有したりする場合にお勧めします。
プロジェクト・ダッシュボードの場所を変更するには
- 左側のサイドバーで、[検索] または[移動] を選択してプロジェクトを見つけるか、[新規作成…]({プラス}) と [新規プロジェクト/リポジトリ] を選択して、ダッシュボード・ファイルを保存するプロジェクトを作成します。
- 左サイドバーの［検索］または［移動］を選択し、分析プロジェクトを見つけます。
- 設定] > [全般]を選択します。
- アナリティクス]を展開します。
- Analytics Dashboards] セクションで、ダッシュボード ファイル プロジェクトを選択します。
- 変更を保存を選択します。
ダッシュボードの定義
ダッシュボードを定義するには
-
.gitlab/analytics/dashboards/に、ダッシュボードと同じ名前のディレクトリを作成します。各ダッシュボードには、それぞれのディレクトリが必要です。
-
新しいディレクトリに、ディレクトリと同じ名前の
.yamlファイルを作成します（例：.gitlab/analytics/dashboards/my_dashboard/my_dashboard.yaml）。このファイルにはダッシュボードの定義が含まれます。
ee/app/validators/json_schemas/analytics_dashboard.jsonで定義されている JSON スキーマに準拠している必要があります。 -
オプション。ダッシュボードに追加する新しい視覚化を作成するには、チャート視覚化の定義を参照してください。
たとえば、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
チャート視覚化の定義
様々なChartを定義し、いくつかのChartに可視化オプションを追加することができます：
- ECharts ドキュメントに記載されているオプションを使用した折れ線グラフ。
- ECharts ドキュメントに記載されているオプションを使用した列チャート。
-
links（オブジェクトの配列で、それぞれtextとhrefプロパティを持ち、リンクで使用する次元を指定します。）例参照)。 -
decimalPlaces（数値、デフォルト値は0）を設定する唯一のオプションを持つ単一の統計。
ダッシュボードのChartを定義するには：
-
.gitlab/analytics/dashboards/visualizations/ディレクトリに.yamlファイルを作成します。ファイル名には、定義する可視化を表す名前を付けます。 -
.yamlファイルで、ee/app/validators/json_schemas/analytics_visualization.jsonのスキーマに従って可視化設定を定義します。
例えば、経時的なイベント数を示す折れ線グラフを作成するには、visualizations フォルダに、以下の必須フィールドを持つline_chart.yaml ファイルを作成します：
- バージョン
- タイプ
- データ
- オプション
カスタムダッシュボードの作成
カスタムダッシュボードを作成するには
- 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
- 分析 > 分析ダッシュボードを選択します。
- 新しいダッシュボードを選択します。
- 新しいダッシュボードの入力に、ダッシュボードの名前を入力します。
- 右側の [Add visualizations] リストから、ダッシュボードに追加するビジュアライゼーションを選択します。
- オプション。選択したパネルをドラッグまたはサイズ変更します。
- Save を選択します。
カスタムダッシュボードの編集
カスタムダッシュボードのタイトルを編集し、ダッシュボードデザイナでビジュアライゼーションを追加またはサイズ変更できます。
既存のカスタムダッシュボードを編集するには
- 左のサイドバーで「検索」または「移動」を選択してあなたのプロジェクトを検索します。
- 分析 > 分析ダッシュボードを選択します。
- 利用可能なダッシュボードのリストから、編集するカスタムダッシュボード（
By GitLabラベルのないもの）を選択します。 - 編集]を選択します。
- オプション。ダッシュボードのタイトルを変更します。
- オプション。右側の [Add visualizations] リストから、ダッシュボードに追加する他のビジュアライゼーションを選択します。
- オプション。ダッシュボードでパネルを選択し、ドラッグまたはサイズ変更します。
- Save を選択します。
トラブルシューティング
Something went wrong while loading the dashboard.
ダッシュボードに「データをロードできませんでした」というグローバルエラーメッセージが表示される場合は、まずページを再読み込みしてみてください。エラーが解消されない場合は、次の手順を実行します：
- 設定が
ee/app/validators/json_schemas/analytics_dashboard.jsonで定義されているダッシュボード JSON スキーマと一致していることを確認します。 - 製品分析については、管理者とプロジェクトの設定を確認し、それらが正しく設定されていることを確認してください。
Invalid visualization configuration
ダッシュボード・パネルで視覚化設定が無効であるというメッセージが表示される場合は、視覚化設定がee/app/validators/json_schemas/analytics_visualization.jsonで定義されている視覚化 JSON スキーマと一致していることを確認してください。
ダッシュボードパネルのエラー
ダッシュボードパネルにエラーメッセージが表示された場合：