Re-add Product Analytics feature flag and update docs
What does this MR do and why?
Since Product Analytics (PA) is being deprioritised, we're moving PA back into closed beta behind a default-off feature flag.
Adding the feature flag will make it clear to self-managed instances that we don't currently support it. We can manually enable it for specific projects on .com as needed. There are currently no self-managed or dedicated users of PA.
MR acceptance checklist
Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.
Screenshots or screen recordings
Screenshots are required for UI changes, and strongly recommended for all other merge requests.
Scenario | Flag disabled | Flag enabled |
---|---|---|
Listing - PA not set up | ![]() |
![]() |
Listing - PA set up |
![]() |
![]() |
Dashboard editor |
![]() |
![]() |
Dashboards page - Non-PA dashboard | ![]() |
![]() |
Dashboards page - built in | ![]() |
![]() |
Dashboards page - Custom |
![]() |
![]() |
How to set up and validate locally
- You need a GitLab Ultimate license.
- Navigate to Project > Analytics > Analytics dashboards
- Verify that you can see the VSA dashboard, but can't set up PA.
- Enable the new feature flag:
echo "Feature.enable(:product_analytics_features)" | gdk rails c
- Follow the guide to enable product analytics on your GDK.
- Navigate back to Project > Analytics > Analytics dashboards.
- Click on the alert CTA on the dashboard listing to enable custom dashboards.
- Verify that you can set up PA, create PA dashboards, and navigate around.
Related to Bring Product Analytics back to a closed beta s... (#495013 - closed)
Merge request reports
Activity
changed milestone to %17.5
assigned to @rob.hunt
added pipelinetier-1 label
added 2 commits
- A deleted user
added documentation label
- Resolved by Robert Hunt
1 Message This merge request adds or changes documentation files. A review from the Technical Writing team before you merge is recommended. Reviews can happen after you merge. Documentation review
The following files require a review from a technical writer:
-
doc/api/product_analytics.md
(Link to current live version) -
doc/user/product_analytics/index.md
(Link to current live version)
The review does not need to block merging this merge request. See the:
-
Metadata for the
*.md
files that you've changed. The first few lines of each*.md
file identify the stage and group most closely associated with your docs change. - The Technical Writer assigned for that stage and group.
- Documentation workflows for information on when to assign a merge request for review.
Pipeline Changes
This merge request contains changes to the pipeline configuration for the GitLab project.
Please consider the effect of the changes in this merge request on the following:
- Effects on different pipeline types
- Effects on non-canonical projects:
gitlab-foss
security
dev
- personal forks
- Effects on pipeline performance
Please consider communicating these changes to the broader team following the communication guideline for pipeline changes
Reviewer roulette
Category Reviewer Maintainer backend @jfypk
(UTC+0, 1 hour behind author)
@mwoolf
(UTC+1, same timezone as author)
test for spec/features/*
@jfypk
(UTC+0, 1 hour behind author)
Maintainer review is optional for test for spec/features/*
~"Pipeline configuration" Reviewer review is optional for ~"Pipeline configuration" @acunskis
(UTC+3, 2 hours ahead of author)
Please refer to documentation page for guidance on how you can benefit from the Reviewer Roulette, or use the GitLab Review Workload Dashboard to find other available reviewers.
If needed, you can retry the
danger-review
job that generated this comment.Generated by
Danger-
author note (non-blocking): If the flag is disabled, the visualization designer will currently show an empty list of visualization options. This is a known issue, we need to add an empty state, although this will be remediated as we add additional data sources to reduce the likelihood this will happen in the first place.
- Resolved by Robert Hunt
- Resolved by Halil Coban
- Resolved by Lorena Ciutacu
@lciutacu would you mind reviewing the docs changes in this MR?
Note: !167296 (comment 2131246274). Generally, we're looking to bring Product Analytics back into closed beta.
requested review from @lciutacu
- Resolved by Halil Coban
@mwoolf would you mind doing the initial backend review?
. I'd be particularly keen on your thoughts on: !167296 (comment 2131248233).
requested review from @mwoolf
requested review from @zmartins
- Resolved by Max Woolf
- Resolved by Max Woolf
- Resolved by Max Woolf
- Resolved by Max Woolf
requested review from @halilcoban
added pipeline:mr-approved label
added pipelinetier-3 pipeline:run-e2e-omnibus-once labels and removed pipelinetier-1 label
Before you set this MR to auto-merge
This merge request will progress on pipeline tiers until it reaches the last tier: pipelinetier-3. We will trigger a new pipeline for each transition to a higher tier.
Before you set this MR to auto-merge, please check the following:
- You are the last maintainer of this merge request
- The latest pipeline for this merge request is pipelinetier-3 (You can find which tier it is in the pipeline name)
- This pipeline is recent enough (created in the last 8 hours)
If all the criteria above apply, please set auto-merge for this merge request.
See pipeline tiers and merging a merge request for more details.
E2E Test Result Summary
allure-report-publisher
generated test report!e2e-test-on-gdk:
test report for a6cd03a8expand test summary
+------------------------------------------------------------------+ | suites summary | +-------------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +-------------+--------+--------+---------+-------+-------+--------+ | Plan | 75 | 0 | 1 | 1 | 76 | ✅ | | Package | 24 | 0 | 11 | 0 | 35 | ✅ | | Verify | 45 | 0 | 2 | 0 | 47 | ✅ | | Create | 128 | 0 | 18 | 0 | 146 | ✅ | | Fulfillment | 2 | 0 | 0 | 0 | 2 | ✅ | | Monitor | 16 | 0 | 0 | 0 | 16 | ✅ | | Govern | 72 | 0 | 0 | 0 | 72 | ✅ | | Analytics | 2 | 0 | 0 | 0 | 2 | ✅ | | Secure | 4 | 0 | 0 | 0 | 4 | ✅ | | Release | 5 | 0 | 0 | 0 | 5 | ✅ | | Data Stores | 33 | 0 | 1 | 0 | 34 | ✅ | | Manage | 1 | 0 | 1 | 0 | 2 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+ | Total | 407 | 0 | 34 | 1 | 441 | ✅ | +-------------+--------+--------+---------+-------+-------+--------+
e2e-test-on-omnibus:
test report for be90bfccexpand test summary
+--------------------------------------------------------------+ | suites summary | +---------+--------+--------+---------+-------+-------+--------+ | | passed | failed | skipped | flaky | total | result | +---------+--------+--------+---------+-------+-------+--------+ | Monitor | 16 | 0 | 24 | 0 | 40 | ✅ | +---------+--------+--------+---------+-------+-------+--------+ | Total | 16 | 0 | 24 | 0 | 40 | ✅ | +---------+--------+--------+---------+-------+-------+--------+
removed pipeline:run-e2e-omnibus-once label
- Resolved by Halil Coban
Hey @halilcoban
, could you please make sure this merge request gets merged?The merge request has all the required approvals, as well as a successful tier-3 pipeline, but is currently not mergeable (MR
detailed_merge_status
is discussions_not_resolved).This message was generated automatically. You're welcome to improve it.
- Resolved by Max Woolf
@ichernikov Could you do the test review please?
requested review from @ichernikov and removed review request for @zmartins
reset approvals from @mwoolf and @halilcoban by pushing to the branch
requested review from @lciutacu
requested review from @splattael
requested review from @sliaquat and removed review request for @splattael
- Resolved by Sanad Liaquat
started a merge train
mentioned in commit 9f829ba5
added workflowstaging-canary label
added workflowcanary label and removed workflowstaging-canary label
added workflowstaging label and removed workflowcanary label
added workflowproduction label and removed workflowstaging label
mentioned in merge request !167918 (merged)
added releasedcandidate label
added releasedpublished label and removed releasedcandidate label
mentioned in merge request !171023 (merged)