Usage ping for JUnit test report

Problem to solve

Customers can view the Unit test report in CI but we don't know how often they actually look at that report via the pipeline page. It is hard to measure if changes to the report result in more views and value for customers.

Intended users

N/A - internal usage

User experience goal

The user (Product Manager at GitLab) should be able to view a graph of Unit Test Report page views by user over time in Sisense.

Proposal

Add a tracking event that fires when people expand the click on the Tests tab on the pipeline page

The counters to add to known_events.yml are:

• unit_test_report_total - add the user_id to the counter when the user (regardless of plan type) clicks the test tab on the pipeline page.

Details for known_events.yml

name: i_testing_unit_test_report_total
  category: testing
  redis_slot: testing
  aggregation: weekly

Metric name already added to event dictionary but double check the new metrics dictionary docs.

Further details

Permissions and Security

None.

Documentation

None.

Availability & Testing

N/A

What does success look like, and how can we measure that?

Users of Junit Reports broken out by license tier, displays on the Testing Group Metrics Sisense dashboard.

What is the type of buyer?

N/A - internal user.

Is this a cross-stage feature?

No.

Links / references

Original Writeup / copy from usage ping issue

Summary

We don't have a way to check how many users are using the feature - JUnit XML test report

We should count the number of projects which uses this feature, periodically.

In other words,

select count(distinct project_id) from ci_job_artifacts where file_type = 4;

Reference: https://docs.gitlab.com/ee/ci/junit_test_reports.html#comment-4059531199