gitlab-org--gitlab-foss/doc/development/service_ping/metrics_lifecycle.md

stage	group	info
Analytics	Product Intelligence	To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments

Service Ping metric lifecycle

The following guidelines explain the steps to follow at each stage of a metric's lifecycle.

Add a new metric

Follow the Implement Service Ping guide.

Change an existing metric

See this video tutorial 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. If there is a problem with an existing metric, it's best to deprecate the existing metric, and use it, side by side, with the desired new metric.

Example: Consider following change. Before GitLab 12.6, the example_metric was implemented as:

{
  ...
  example_metric: distinct_count(Project, :creator_id)
}

For GitLab 12.6, the metric was changed to filter out archived projects:

{
  ...
  example_metric: distinct_count(Project.non_archived, :creator_id)
}

In this scenario, all instances running up to GitLab 12.5 continue to report example_metric, including all archived projects, while all instances running GitLab 12.6 and higher filters out such projects. As Service Ping data is collected from all reporting instances, the resulting dataset includes mixed data, which distorts any following business analysis.

The correct approach is to add a new metric for GitLab 12.6 release with updated logic:

{
  ...
  example_metric_without_archived: distinct_count(Project.non_archived, :creator_id)
}

and update existing business analysis artefacts to use example_metric_without_archived instead of example_metric

Currently, the Metrics Dictionary is built automatically once a day. When a change to a metric is made in a YAML file, you can see the change in the dictionary within 24 hours.

Remove a metric

WARNING: If a metric is not used in Sisense or any other system after 6 months, the Product Intelligence team marks it as inactive and assigns it to the group owner for review.

We are working on automating this process. See this issue for details.

Product Intelligence removes metrics from Service Ping if they are not used in any Sisense dashboard.

For an example of the metric removal process, see this example issue.

To remove a metric:

1. Check the following YAML files and verify the metric is not used in an aggregate:

   • config/metrics/aggregates/*.yaml
   • ee/config/metrics/aggregates/*.yaml

2. Verify the metric is not used to calculate the conversational index. The conversational index is a measure that reports back to self-managed instances to inform administrators of the progress of DevOps adoption for the instance.

   You can check CalculateConvIndexService to view the metrics that are used. The metrics are represented as the keys that are passed as a field argument into the get_value method.

3. Verify that removing the metric from the Service Ping payload does not cause errors in Version App when the updated payload is collected and processed. Version App collects and persists all Service Ping reports. To verify Service Ping processing in your local development environment, follow this guide. Alternatively, you can modify fixtures used to test the UsageDataController#create endpoint, and assure that test suite does not fail when metric that you wish to remove is not included into test payload.

4. Remove data from Redis

   For Ordinary Redis counters remove data stored in Redis.

   • Add a migration to remove the data from Redis for the related Redis keys. For more details, see this MR example.

5. Create an issue in the GitLab Data Team project. Ask for confirmation that the metric is not referred to in any SiSense dashboards and can be safely removed from Service Ping. Use this example issue for guidance.

6. After you verify the metric can be safely removed, update the attributes of the metric's YAML definition:

   • Set the status: to removed.
   • Set removed_by_url: to the URL of the MR removing the metric
   • Set milestone_removed: to the number of the milestone in which the metric was removed.

   Do not remove the metric's YAML definition altogether. Some self-managed instances might not immediately update to the latest version of GitLab, and therefore continue to report the removed metric. The Product Intelligence team requires a record of all removed metrics in order to identify and filter them.

   For example please take a look at this merge request.

7. After you verify the metric can be safely removed, remove the metric's instrumentation from lib/gitlab/usage_data.rb or ee/lib/ee/gitlab/usage_data.rb.

   For example please take a look at this merge request.

8. Remove any other records related to the metric:

   • The feature flag YAML file at config/feature_flags/*/*.yaml.
   • The entry in the known events YAML file at lib/gitlab/usage_data_counters/known_events/*.yaml.