• Resources for reviewers
• Review process
  • Roles and process
    • The merge request author should
    • The Product Intelligence reviewer should
• Review workload distribution

Usage Ping review guidelines

This page includes introductory material for a Product Intelligence review, and is specific to Usage Ping related reviews. For broader advice and general best practices for code reviews, refer to our code review guide.

Resources for reviewers

• Usage Ping Guide
• Metrics Dictionary

Review process

We recommend a Product Intelligence review when a merge request (MR) touches any of the following Usage Ping files:

• usage_data* files.
• The Metrics Dictionary, including files in:
  • config/metrics.
  • ee/config/metrics.
  • dictionary.md.
  • schema.json.
• Product Intelligence tooling. For example, Gitlab::UsageMetricDefinitionGenerator

Roles and process

The merge request author should

• Decide whether a Product Intelligence review is needed.
• If a Product Intelligence review is needed, add the labels ~product intelligence and ~product intelligence::review pending.
• Assign an engineer from the Product Intelligence team for a review.
• Set the correct attributes in the metric’s YAML definition:
  • product_section, product_stage, product_group, product_category
  • Provide a clear description of the metric.
• Update the Metrics Dictionary if needed.
• Add a changelog according to guidelines.

The Product Intelligence reviewer should

• Perform a first-pass review on the merge request and suggest improvements to the author.
• Check the metrics location in the Usage Ping JSON payload.
• Add the ~database label and ask for a database review for metrics that are based on Database.
• For tracking using Redis HLL (HyperLogLog):
  • Check the Redis slot.
  • Check if a feature flag is needed.
• For a metric’s YAML definition:
  • Check the metric’s description.
  • Check the metric’s key_path.
  • Check the product_section, product_stage, product_group, and product_category fields. Read the stages file.
  • Check the file location. Consider the time frame, and if the file should be under ee.
  • Check the tiers.
• Approve the MR, and relabel the MR with ~"product intelligence::approved".

Review workload distribution

Danger bot adds the list of changed Product Intelligence files and pings the @gitlab-org/growth/product-intelligence/engineers group for merge requests that are not drafts.

Any of the Product Intelligence engineers can be assigned for the Product Intelligence review.