Commit d6c18eb1 authored by alinamihaila's avatar alinamihaila

Use product_ prefix for group, stage and section

parent 59ab13ac
key_path: counts_monthly.deployments
description: Total deployments count for recent 28 days
value_type: integer
stage: release
product_stage: release
status: data_available
milestone: 13.2
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35493
group: 'group::ops release'
product_group: 'group::ops release'
time_frame: 28d
data_source: database
distribution: [ee, ce]
......
......@@ -2,11 +2,11 @@ key_path: redis_hll_counters.issues_edit.g_project_management_issue_title_change
description: Distinct users count that changed issue title in a group for last recent week
value_type: integer
product_category: issue_tracking
stage: plan
product_stage: plan
status: data_available
milestone: 13.6
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/issues/229918
group: 'group::project management'
product_group: 'group::project management'
time_frame: 7d
data_source: redis_hll
distribution: [ee, ce]
......
key_path: counts.deployments
description: Total deployments count
value_type: integer
stage: release
product_stage: release
status: data_available
milestone: 8.12
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/735
group: 'group::ops release'
product_group: 'group::ops release'
time_frame: all
data_source: database
distribution: [ee, ce]
......
......@@ -2,11 +2,11 @@ key_path: recorded_at
description: When the Usage Ping computation was started
value_type: string
product_category: collection
stage: growth
product_stage: growth
status: data_available
milestone: 8.10
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/557
group: group::product analytics
product_group: group::product intelligence
time_frame: none
data_source: ruby
distribution: [ee, ce]
......
......@@ -2,11 +2,11 @@ key_path: uuid
description: GitLab instance unique identifier
value_type: string
product_category: collection
stage: growth
product_stage: growth
status: data_available
milestone: 9.1
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1521
group: group::product analytics
product_group: group::product intelligence
time_frame: none
data_source: database
distribution: [ee, ce]
......
{
"type": "object",
"required": ["key_path", "description", "value_type", "status", "group", "time_frame", "data_source", "distribution", "tier"],
"required": ["key_path", "description", "value_type", "status", "product_group", "time_frame", "data_source", "distribution", "tier"],
"properties": {
"key_path": {
"type": "string"
......@@ -8,19 +8,25 @@
"description": {
"type": "string"
},
"value_type": {
"type": "string",
"enum": ["integer", "string", "number", "boolean"]
"product_section": {
"type": ["string", "null"]
},
"product_category": {
"product_stage": {
"type": ["string", "null"]
},
"stage": {
"product_group": {
"type": "string"
},
"product_category": {
"type": ["string", "null"]
},
"value_type": {
"type": "string",
"enum": ["integer", "string", "number", "boolean"]
},
"status": {
"type": ["string"],
"enum": ["data_available", "planned", "in_progress", "implmented"]
"enum": ["data_available", "planned", "in_progress", "implemented"]
},
"milestone": {
"type": ["number", "null"]
......@@ -31,9 +37,6 @@
"introduced_by_url": {
"type": ["string", "null"]
},
"group": {
"type": "string"
},
"time_frame": {
"type": "string",
"enum": ["7d", "28d", "all", "none"]
......
......@@ -2,9 +2,9 @@ key_path: database.adapter
description: This metric only returns a value of PostgreSQL in supported versions of GitLab. It could be removed from the usage ping. Historically MySQL was also supported.
value_type: string
product_category: collection
stage: growth
product_stage: growth
status: data_available
group: group::enablement distribution
product_group: group::enablement distribution
time_frame: none
data_source: database
distribution: [ee, ce]
......
......@@ -43,7 +43,7 @@ tracking_files = [
tracking_changed_files = all_changed_files & tracking_files
usage_data_changed_files = all_changed_files.grep(%r{(usage_data)})
metrics_changed_files = all_changed_files.grep(%r{((ee/)?config/metrics/.*\.yml)})
dictionary_changed_file = all_changed_files.grep(%r{(doc/developmet/usage_ping/dictionary.md)})
dictionary_changed_file = all_changed_files.grep(%r{(doc/development/usage_ping/dictionary.md)})
usage_changed_files = usage_data_changed_files + tracking_changed_files + metrics_changed_files + dictionary_changed_file
......
......@@ -37,11 +37,11 @@ Total deployments count
| --- | --- |
| `key_path` | **counts.deployments** |
| `value_type` | integer |
| `stage` | release |
| `product_stage` | release |
| `status` | data_available |
| `milestone` | 8.12 |
| `introduced_by_url` | [Introduced by](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/735) |
| `group` | `group::ops release` |
| `product_group` | `group::ops release` |
| `time_frame` | all |
| `data_source` | Database |
| `distribution` | ee, ce |
......@@ -56,10 +56,10 @@ Total number of sites in a Geo deployment
| `key_path` | **counts.geo_nodes** |
| `value_type` | integer |
| `product_category` | disaster_recovery |
| `stage` | enablement |
| `product_stage` | enablement |
| `status` | data_available |
| `milestone` | 11.2 |
| `group` | `group::geo` |
| `product_group` | `group::geo` |
| `time_frame` | all |
| `data_source` | Database |
| `distribution` | ee |
......@@ -73,11 +73,11 @@ Total deployments count for recent 28 days
| --- | --- |
| `key_path` | **counts_monthly.deployments** |
| `value_type` | integer |
| `stage` | release |
| `product_stage` | release |
| `status` | data_available |
| `milestone` | 13.2 |
| `introduced_by_url` | [Introduced by](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35493) |
| `group` | `group::ops release` |
| `product_group` | `group::ops release` |
| `time_frame` | 28d |
| `data_source` | Database |
| `distribution` | ee, ce |
......@@ -92,9 +92,9 @@ This metric only returns a value of PostgreSQL in supported versions of GitLab.
| `key_path` | **database.adapter** |
| `value_type` | string |
| `product_category` | collection |
| `stage` | growth |
| `product_stage` | growth |
| `status` | data_available |
| `group` | `group::enablement distribution` |
| `product_group` | `group::enablement distribution` |
| `time_frame` | none |
| `data_source` | Database |
| `distribution` | ee, ce |
......@@ -109,11 +109,11 @@ When the Usage Ping computation was started
| `key_path` | **recorded_at** |
| `value_type` | string |
| `product_category` | collection |
| `stage` | growth |
| `product_stage` | growth |
| `status` | data_available |
| `milestone` | 8.1 |
| `introduced_by_url` | [Introduced by](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/557) |
| `group` | `group::product analytics` |
| `product_group` | `group::product intelligence` |
| `time_frame` | none |
| `data_source` | Ruby |
| `distribution` | ee, ce |
......@@ -128,11 +128,11 @@ Distinct users count that changed issue title in a group for last recent week
| `key_path` | **redis_hll_counters.issues_edit.g_project_management_issue_title_changed_weekly** |
| `value_type` | integer |
| `product_category` | issue_tracking |
| `stage` | plan |
| `product_stage` | plan |
| `status` | data_available |
| `milestone` | 13.6 |
| `introduced_by_url` | [Introduced by](https://gitlab.com/gitlab-org/gitlab/-/issues/229918) |
| `group` | `group::project management` |
| `product_group` | `group::project management` |
| `time_frame` | 7d |
| `data_source` | Redis_hll |
| `distribution` | ee, ce |
......@@ -147,11 +147,11 @@ GitLab instance unique identifier
| `key_path` | **uuid** |
| `value_type` | string |
| `product_category` | collection |
| `stage` | growth |
| `product_stage` | growth |
| `status` | data_available |
| `milestone` | 9.1 |
| `introduced_by_url` | [Introduced by](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1521) |
| `group` | `group::product analytics` |
| `product_group` | `group::product intelligence` |
| `time_frame` | none |
| `data_source` | Database |
| `distribution` | ee, ce |
......
......@@ -30,13 +30,13 @@ Each metric is defined in a separate YAML file consisting of a number of fields:
| `description` | yes | |
| `value_type` | yes | |
| `status` | yes | |
| `group` | yes | The [group](https://about.gitlab.com/handbook/product/categories/#devops-stages) that owns the metric. |
| `product_group` | yes | The [group](https://about.gitlab.com/handbook/product/categories/#devops-stages) that owns the metric. |
| `time_frame` | yes | `string`; may be set to a value like "7d" |
| `data_source` | yes | `string`: may be set to a value like `database` or `redis_hll`. |
| `distribution` | yes | The [distribution](https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/#definitions) where the metric applies. |
| `tier` | yes | The [tier]( https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/) where the metric applies. |
| `product_category` | no | The [product category](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/categories.yml) for the metric. |
| `stage` | no | The [stage](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) for the metric. |
| `product_stage` | no | The [stage](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) for the metric. |
| `milestone` | no | The milestone when the metric is introduced. |
| `milestone_removed` | no | The milestone when the metric is removed. |
| `introduced_by_url` | no | The URL to the Merge Request that introduced the metric. |
......@@ -52,11 +52,11 @@ key_path: uuid
description: GitLab instance unique identifier
value_type: string
product_category: collection
stage: growth
product_stage: growth
status: data_available
milestone: 9.1
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1521
group: group::product intelligence
product_group: group::product intelligence
time_frame: none
data_source: database
distribution: [ee, ce]
......
......@@ -2,10 +2,10 @@ key_path: counts.geo_nodes
description: Total number of sites in a Geo deployment
value_type: integer
product_category: disaster_recovery
stage: enablement
product_stage: enablement
status: data_available
milestone: 11.2
group: 'group::geo'
product_group: 'group::geo'
time_frame: all
data_source: database
distribution: [ee]
......
......@@ -10,7 +10,7 @@ module Gitlab
"**#{value}**"
when :data_source
value.capitalize
when :group
when :product_group
"`#{value}`"
when :introduced_by_url
"[Introduced by](#{value})"
......
......@@ -6,7 +6,7 @@ RSpec.describe Gitlab::Usage::Docs::ValueFormatter do
describe '.format' do
using RSpec::Parameterized::TableSyntax
where(:key, :value, :expected_value) do
:group | 'growth::product intelligence' | '`growth::product intelligence`'
:product_group | 'growth::product intelligence' | '`growth::product intelligence`'
:data_source | 'redis' | 'Redis'
:data_source | 'ruby' | 'Ruby'
:introduced_by_url | 'http://test.com' | '[Introduced by](http://test.com)'
......
......@@ -8,11 +8,11 @@ RSpec.describe Gitlab::Usage::MetricDefinition do
description: 'GitLab instance unique identifier',
value_type: 'string',
product_category: 'collection',
stage: 'growth',
product_stage: 'growth',
status: 'data_available',
default_generation: 'generation_1',
key_path: 'uuid',
group: 'group::product analytics',
product_group: 'group::product analytics',
time_frame: 'none',
data_source: 'database',
distribution: %w(ee ce),
......@@ -45,7 +45,7 @@ RSpec.describe Gitlab::Usage::MetricDefinition do
:value_type | 'test'
:status | nil
:key_path | nil
:group | nil
:product_group | nil
:time_frame | nil
:time_frame | '29d'
:data_source | 'other'
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment