Add Value stream dashboard to product analytics dashboards
What does this MR do and why?
This MR adds the Value stream dashboard to the list of dashboards available in product analytics at the project level.
Background
This is a spike to explore how the groupoptimize value stream dashboard can be added in analytics dashboard.
Findings of this spike:
-
✅ Successfully added VSD dashboard to list of builtin analytics dashboards. -
✅ Successfully added a newvalue_stream
data source for optimize. -
✅ Successfully added a DORA chart visualization. -
✅ Successfully created a custom VSD dashboard. -
👷 Data sourcefetch
is a little bit awkward when we're not fetching. Recommend we change it to a default export. -
👷 All the backend code is currently scoped toProductAnalytics
and needs to be updated toAnalytics
/AnalyticsDashboard
. -
👷 Nothing is validated against the schema and the configs are subject to change. We'll have to coordinate before we ship something asv1
to customers.
No immediate blockers.
Screenshots or screen recordings
How to set up and validate locally
- Make sure you are on GitLab Ultimate
- Follow these instructions to set up Product Analytics in your GDK.
- This change is dependant on snowplow flagged changes. Please also enable
echo "Feature.enable(:product_analytics_snowplow_support)" | gdk rails c
.
- This change is dependant on snowplow flagged changes. Please also enable
- Create a new project with an empty repository.
- Enable custom dashboards at Project > Settings > Analytics and pick the empty project.
- Create a custom dashboard by following these instructions.
- View the
VSD
dashboard at Project > Settings > Analytics. - To add a custom dashboard, paste the following in
.gitlab/analytics/dashboards/vsd_custom/vsd_custom.yaml
:
---
version: 1
title: VSD custom dashboard
description: Created using custom dashboards
panels:
- id: 1
visualization: dora_chart
title: DORA
gridAttributes:
yPos: 1
xPos: 0
width: 12
height: 6
options: {}
queryOverrides:
namespace:
name: gitlab-org/snowplow2/-/analytics/dashboards
requestPath: awesome-co-root-58e999/ops
isProject: 'true'
- Seed DORA metrics data for your selected project
MR acceptance checklist
This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.
-
I have evaluated the MR acceptance checklist for this MR.
Edited by Robert Hunt