diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md index 21b1629bf7d6252522e8587d30a06584a2797a2e..4df6fa6a47f9e76bd2111f39a78cc1676c007ea3 100644 --- a/doc/api/usage_data.md +++ b/doc/api/usage_data.md @@ -65,8 +65,6 @@ Example response: - key_path: redis_hll_counters.search.i_search_paid_monthly description: Calculated unique users to perform a search with a paid license enabled by month - product_section: enablement - product_stage: enablement product_group: global_search value_type: number status: active diff --git a/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md b/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md index 6cd1e3d6aa30d43dbda771b1a9d1744409a90d19..f899c8b9b2ffd6153045a5fd1c5cd75232183188 100644 --- a/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md +++ b/doc/development/internal_analytics/internal_event_instrumentation/event_definition_guide.md @@ -29,8 +29,6 @@ Each event is defined in a separate YAML file consisting of the following fields | `category` | no | Required for legacy events. Should not be used for Internal Events. | | `action` | yes | A unique name for the event. Only lowercase, numbers, and underscores are allowed. Use the format `<operation>_<target_of_operation>_<where/when>`. <br/><br/> Ex: `publish_go_module_to_the_registry_from_pipeline` <br/>`<operation> = publish`<br/>`<target> = go_module`<br/>`<when/where> = to_the_registry_from_pipeline`. | | `identifiers` | no | A list of identifiers sent with the event. Can be set to one or more of `project`, `user`, or `namespace`. | -| `product_section` | yes | The [section](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/sections.yml). | -| `product_stage` | no | The [stage](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) for the event. | | `product_group` | yes | The [group](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) that owns the event. | | `milestone` | no | The milestone when the event is introduced. | | `introduced_by_url` | no | The URL to the merge request that introduced the event. | @@ -49,8 +47,6 @@ identifiers: - project - user - namespace -product_section: dev -product_stage: monitor product_group: group::product analytics milestone: "16.4" introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/128029 diff --git a/doc/development/internal_analytics/metrics/metrics_dictionary.md b/doc/development/internal_analytics/metrics/metrics_dictionary.md index 9252b2148b37d7acd64ab06a2f27012c09fe02c7..776075d7e96c9666564dd3b954846ed9f215969d 100644 --- a/doc/development/internal_analytics/metrics/metrics_dictionary.md +++ b/doc/development/internal_analytics/metrics/metrics_dictionary.md @@ -33,8 +33,6 @@ Each metric is defined in a separate YAML file consisting of a number of fields: |------------------------------|----------|------------------------| | `key_path` | yes | JSON key path for the metric, location in Service Ping payload. | | `description` | yes | | -| `product_section` | yes | The [section](https://gitlab.com/gitlab-com/www-gitlab-com/-/blob/master/data/sections.yml). | -| `product_stage` | yes | The [stage](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) for the metric. | | `product_group` | yes | The [group](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml) that owns the metric. | | `value_type` | yes | `string`; one of [`string`, `number`, `boolean`, `object`](https://json-schema.org/understanding-json-schema/reference/type). | | `status` | yes | `string`; [status](#metric-statuses) of the metric, may be set to `active`, `removed`, `broken`. | @@ -117,8 +115,6 @@ instance unique identifier. ```yaml key_path: uuid description: GitLab instance unique identifier -product_section: analytics -product_stage: analytics product_group: analytics_instrumentation value_type: string status: active diff --git a/doc/development/internal_analytics/review_guidelines.md b/doc/development/internal_analytics/review_guidelines.md index 9dfe6b8d787721ca55b8cc00b9000c0294861257..3be3f9fe69fb96b44e1d366cd34886bff9c58aa3 100644 --- a/doc/development/internal_analytics/review_guidelines.md +++ b/doc/development/internal_analytics/review_guidelines.md @@ -53,7 +53,7 @@ In most cases, an Analytics Instrumentation review is automatically added, but i - For a metric's YAML definition: - Check the metric's `description`. - Check the metric's `key_path`. - - Check the `product_section`, `product_stage`, and `product_group` fields. + - Check the `product_group` field. They should correspond to the [stages file](https://gitlab.com/gitlab-com/www-gitlab-com/blob/master/data/stages.yml). - Check the file location. Consider the time frame, and if the file should be under `ee`. - Check the tiers.