Product analytics

Introduced in GitLab 15.4 as an Alpha feature with a flag named cube_api_proxy. Disabled by default.

On self-managed GitLab, by default this feature is not available. To make it available per project or for your entire instance, ask an administrator to enable the feature flag named cube_api_proxy. On GitLab.com, this feature is not available. This feature is not ready for production use.

This page is a work in progress, and we’re updating the information as we add more features. For more information, visit the Product Analytics group direction page.

Enable product analytics

You can enable and configure product analytics to track events within your project applications on a self-managed instance.

Prerequisite:

  • You must be an administrator of a self-managed GitLab instance.
  1. On the top bar, select Main menu > Admin.
  2. On the left sidebar, select Settings > General.
  3. Expand the Product analytics section.

  4. Select Enable product analytics and enter the configuration values. The following table shows the required configuration parameters and example values:

    Name Value
    Jitsu host https://jitsu.gitlab.com
    Jitsu project ID g0maofw84gx5sjxgse2k
    Jitsu administrator email jitsu.admin@gitlab.com
    Jitsu administrator password <your_password>
    Clickhouse URL https://<username>:<password>@clickhouse.gitlab.com:8123
    Cube API URL https://cube.gitlab.com
    Cube API key 25718201b3e9...ae6bbdc62dbb
  5. Select Save changes.

Product analytics dashboards

Each project can define an unlimited number of dashboards. These dashboards are defined using our YAML schema and stored in the .gitlab/product_analytics/dashboards/ directory of a project repository. The name of the file is the name of the dashboard, and visualizations are shared across dashboards.

Project maintainers can enforce approval rules on dashboard changes using features such as code owners and approval rules. Dashboards are versioned in source control with the rest of a project’s code.

Define a dashboard

To define a dashboard:

  1. In .gitlab/product_analytics/dashboards/, create a directory named like the dashboard. Each dashboard should have its own directory.
  2. In the new directory, create a .yaml file with the same name as the directory. This file contains the dashboard definition, and must conform to the JSON schema defined in ee/app/validators/json_schemas/product_analytics_dashboard.json.
  3. In the .gitlab/product_analytics/dashboards/visualizations/ directory, create a yaml file. This file defines the visualization type for the dashboard, and must conform to the schema in ee/app/validators/json_schemas/product_analytics_visualization.json.

The example below includes three dashboards and one visualization that applies to all dashboards. 

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