Merge branch 'mwaw/301055-update-metrics-definitions-for-product-intelligence-group' into 'master'

Update Metrics definitions for Product Intelligence group

See merge request gitlab-org/gitlab!57377

changelogs/unreleased/mwaw-301055-update-metrics-definitions-for-product-intelligence-group.yml

+---
+title: Deprecate Product Intelligence test aggregated metrics
+merge_request: 57377
+author:
+type: deprecated

config/metrics/aggregates/common.yml

@@ -27,22 +27,6 @@
     - 'i_compliance_audit_events'
     - 'a_compliance_audit_events_api'
     - 'i_compliance_credential_inventory'
-- name: product_analytics_test_metrics_union
-  operator: OR
-  source: redis
-  time_frame: [7d, 28d]
-  events:
-    - 'i_search_total'
-    - 'i_search_advanced'
-    - 'i_search_paid'
-- name: product_analytics_test_metrics_intersection
-  operator: AND
-  source: redis
-  time_frame: [7d, 28d]
-  events:
-    - 'i_search_total'
-    - 'i_search_advanced'
-    - 'i_search_paid'
 - name: incident_management_alerts_total_unique_counts
   operator: OR
   source: redis

config/metrics/counts_28d/20210216183203_product_analytics_test_metrics_union.yml

 ---
 key_path: counts_monthly.aggregated_metrics.product_analytics_test_metrics_union
-description: ''
-product_section: ''
-product_stage: ''
-product_group: ''
-product_category: ''
+description: This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
 value_type: number
-status: data_available
-time_frame: 28d
-data_source: database
+status: removed
+milestone_removed: '13.11'
+milestone: '13.7'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49886
+time_frame: 7d
+data_source: redis_hll
 distribution:
-- ce
+  - ce
+  - ee
 tier:
-- free
-skip_validation: true
+  - free
+  - premium
+  - ultimate

config/metrics/counts_28d/20210216183205_product_analytics_test_metrics_intersection.yml

 ---
 key_path: counts_monthly.aggregated_metrics.product_analytics_test_metrics_intersection
-description: ''
-product_section: ''
-product_stage: ''
-product_group: ''
-product_category: ''
+description: This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
 value_type: number
-status: data_available
+status: removed
+milestone_removed: '13.11'
+milestone: '13.7'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49886
 time_frame: 28d
-data_source: database
+data_source: redis_hll
 distribution:
-- ce
+  - ce
+  - ee
 tier:
-- free
-skip_validation: true
+  - free
+  - premium
+  - ultimate

config/metrics/counts_7d/20210216183213_product_analytics_test_metrics_union.yml

+---
+key_path: counts_weekly.aggregated_metrics.product_analytics_test_metrics_union
+description: This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: number
+status: removed
+milestone_removed: '13.11'
+milestone: '13.7'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49886
+time_frame: 7d
+data_source: redis_hll
+distribution:
+  - ce
+  - ee
+tier:
+  - free
+  - premium
+  - ultimate

config/metrics/counts_7d/20210216183215_product_analytics_test_metrics_intersection.yml

+---
+key_path: counts_weekly.aggregated_metrics.product_analytics_test_metrics_intersection
+description: This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: number
+status: removed
+milestone_removed: '13.11'
+milestone: '13.7'
+introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49886
+time_frame: 7d
+data_source: redis_hll
+distribution:
+  - ce
+  - ee
+tier:
+  - free
+  - premium
+  - ultimate

config/metrics/schema.json

@@ -30,7 +30,7 @@
     },
     "status": {
       "type": ["string"],
-      "enum": ["data_available", "implemented", "not_used", "deprecated"]
+      "enum": ["data_available", "implemented", "not_used", "deprecated", "removed"]
     },
     "milestone": {
       "type": ["string", "null"],

doc/development/usage_ping/dictionary.md

@@ -6154,27 +6154,27 @@ Tiers: `free`
 
 ### `counts_monthly.aggregated_metrics.product_analytics_test_metrics_intersection`
 
-Missing description
+This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_28d/20210216183205_product_analytics_test_metrics_intersection.yml)
 
-Group: ``
+Group: `group::product intelligence`
 
-Status: `data_available`
+Status: `removed`
 
-Tiers: `free`
+Tiers: `free`, `premium`, `ultimate`
 
 ### `counts_monthly.aggregated_metrics.product_analytics_test_metrics_union`
 
-Missing description
+This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
 
 [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_28d/20210216183203_product_analytics_test_metrics_union.yml)
 
-Group: ``
+Group: `group::product intelligence`
 
-Status: `data_available`
+Status: `removed`
 
-Tiers: `free`
+Tiers: `free`, `premium`, `ultimate`
 
 ### `counts_monthly.deployments`
 
@@ -6322,27 +6322,27 @@ Tiers:
 
 ### `counts_weekly.aggregated_metrics.product_analytics_test_metrics_intersection`
 
-Missing description
+This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
 
-[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216183215_product_analytics_test_metrics_intersection.yml)
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_7d/20210216183215_product_analytics_test_metrics_intersection.yml)
 
-Group: ``
+Group: `group::product intelligence`
 
-Status: `data_available`
+Status: `removed`
 
-Tiers:
+Tiers: `free`, `premium`, `ultimate`
 
 ### `counts_weekly.aggregated_metrics.product_analytics_test_metrics_union`
 
-Missing description
+This was test metric used for purpose of assuring correct implementation of aggregated metrics feature
 
-[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216183213_product_analytics_test_metrics_union.yml)
+[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_7d/20210216183213_product_analytics_test_metrics_union.yml)
 
-Group: ``
+Group: `group::product intelligence`
 
-Status: `data_available`
+Status: `removed`
 
-Tiers:
+Tiers: `free`, `premium`, `ultimate`
 
 ### `database.adapter`
 

doc/development/usage_ping/metrics_dictionary.md

@@ -33,7 +33,7 @@ Each metric is defined in a separate YAML file consisting of a number of fields:
 | `product_group`     | yes      | The [group](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) that owns the metric. |
 | `product_category`  | no       | The [product category](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/categories.yml) for the metric. |
 | `value_type`        | yes      | `string`; one of [`string`, `number`, `boolean`, `object`](https://json-schema.org/understanding-json-schema/reference/type.html).                                                     |
-| `status`            | yes      | `string`; [status](#metric-statuses) of the metric, may be set to `data_available`, `implemented`, `not_used`, `deprecated`. |
+| `status`            | yes      | `string`; [status](#metric-statuses) of the metric, may be set to `data_available`, `implemented`, `not_used`, `deprecated`, `removed`. |
 | `time_frame`        | yes      | `string`; may be set to a value like `7d`, `28d`, `all`, `none`. |
 | `data_source`       | yes      | `string`; may be set to a value like `database`, `redis`, `redis_hll`, `prometheus`, `ruby`. |
 | `distribution`      | yes      | `array`; may be set to one of `ce, ee` or `ee`. The [distribution](https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/#definitions) where the tracked feature is available.  |
@@ -52,6 +52,7 @@ Metric definitions can have one of the following statuses:
   status for newly added metrics awaiting inclusion in a new release.
 - `not_used`: Metric is not used in any dashboard.
 - `deprecated`: Metric is deprecated and possibly planned to be removed.
+- `removed`: Metric was removed, but it may appear in Usage Ping payloads sent from instances running on older versions of GitLab.
 
 ### Example YAML metric definition
 

ee/config/metrics/aggregates/common.yml

@@ -14,10 +14,11 @@
 #  feature_flag: name of development feature flag that will be checked before metrics aggregation is performed.
 #                Corresponding feature flag should have `default_enabled` attribute set to `false`.
 #                This attribute is OPTIONAL and can be omitted, when `feature_flag` is missing no feature flag will be checked.
-- name: product_analytics_test_metrics_intersection_database_sourced
-  source: database
-  time_frame: [28d]
-  events:
-    - 'dependency_scanning_pipeline'
-    - 'container_scanning_pipeline'
-  operator: AND
+# Example:
+#- name: product_analytics_test_metrics_intersection_database_sourced
+#  source: database
+#  time_frame: [28d]
+#  events:
+#    - 'dependency_scanning_pipeline'
+#    - 'container_scanning_pipeline'
+#  operator: AND

ee/config/metrics/counts_7d/20210216183213_product_analytics_test_metrics_union.yml

----
-key_path: counts_weekly.aggregated_metrics.product_analytics_test_metrics_union
-description: ''
-product_section: ''
-product_stage: ''
-product_group: ''
-product_category: ''
-value_type: number
-status: data_available
-time_frame: 7d
-data_source: database
-distribution:
-- ee
-tier: []
-skip_validation: true

ee/config/metrics/counts_7d/20210216183215_product_analytics_test_metrics_intersection.yml

----
-key_path: counts_weekly.aggregated_metrics.product_analytics_test_metrics_intersection
-description: ''
-product_section: ''
-product_stage: ''
-product_group: ''
-product_category: ''
-value_type: number
-status: data_available
-time_frame: 7d
-data_source: database
-distribution:
-- ee
-tier: []
-skip_validation: true