diff options
Diffstat (limited to 'doc/development/service_ping/metrics_lifecycle.md')
| -rw-r--r-- | doc/development/service_ping/metrics_lifecycle.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/doc/development/service_ping/metrics_lifecycle.md b/doc/development/service_ping/metrics_lifecycle.md index ebfab6341e9..a7ecf15a493 100644 --- a/doc/development/service_ping/metrics_lifecycle.md +++ b/doc/development/service_ping/metrics_lifecycle.md @@ -14,6 +14,11 @@ Follow the [Implement Service Ping](implement.md) guide. ## Change an existing metric +See [this video tutorial](https://youtu.be/bYf3c01KCls) for help with the update of metric attributes. + +NOTE: +The `key_path` attribute represents the location of the metric in Service Ping payload and must not be changed. + Because we do not control when customers update their self-managed instances of GitLab, we **STRONGLY DISCOURAGE** changes to the logic used to calculate any metric. Any such changes lead to inconsistent reports from multiple GitLab instances. @@ -85,10 +90,9 @@ To remove a metric: 1. Verify that removing the metric from the Service Ping payload does not cause errors in [Version App](https://gitlab.com/gitlab-services/version-gitlab-com) when the updated payload is collected and processed. Version App collects - and persists all Service Ping reports. To do that you can modify - [fixtures](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/spec/support/usage_data_helpers.rb#L540) - used to test - [`UsageDataController#create`](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/3760ef28/spec/controllers/usage_data_controller_spec.rb#L75) + and persists all Service Ping reports. To verify Service Ping processing in your local development environment, follow this [guide](https://www.youtube.com/watch?v=FS5emplabRU). + Alternatively, you can modify [fixtures](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/master/spec/support/usage_data_helpers.rb#L540) + used to test the [`UsageDataController#create`](https://gitlab.com/gitlab-services/version-gitlab-com/-/blob/3760ef28/spec/controllers/usage_data_controller_spec.rb#L75) endpoint, and assure that test suite does not fail when metric that you wish to remove is not included into test payload. 1. Create an issue in the |