Analytics Instrumentation Principles

Checklist

Ensure every fired event has a corresponding definition file in config/events or ee/config/events.
Verify the event definition file is correct and complete.
DO NOT include sensitive information (per the data classification standard) in tracking parameters.
DO NOT use deprecated analytics methods.

Add the ~database label and request a database review for metrics based on database queries.
Verify the metric's description field is accurate and meaningful.
Verify the metric's key_path is correct.
Check the product_group field corresponds to the stages file
Verify the file location reflects the correct time frame and whether it belongs under ee/.
Verify the metric's tiers are correctly set.
Ensure changed or removed metrics have notified @csops-team, @gitlab-data/analytics-engineers, and @gitlab-data/product-analysts via a comment on the issue, and all groups have acknowledged the change.

Verify new events fire correctly locally using the available testing tools.
Verify new metrics appear in the Service Ping payload by running require_relative 'spec/support/helpers/service_ping_helpers.rb'; ServicePingHelpers.get_current_usage_metric_value(key_path) with the metric's key_path.

Ensure CLI changes follow the CLI style guide.
Verify CLI UX: content is easy to skim, meaningful to people outside the team, and all inputs have clear meaning and effect.
Verify edge cases and caveats include instructions to validate whether the user needs to act on them.

Apply ~analytics instrumentation and ~analytics instrumentation::review pending labels when an Analytics Instrumentation review is needed but was not assigned automatically.
Approve the MR and relabel with ~"analytics instrumentation::approved" upon completion.
DO NOT require a maintainer review for ~analytics instrumentation reviews.

For the full picture, see: