Add add_on_metrics Field to HistoricalData

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

• Close this issue

Background

We currently track add-on metrics as part of seat link records for online cloud licenses to provide visibility into Duo seat adoption for Self-Managed customers.

Now that offline cloud license customers can purchase Duo Enterprise, we will need to capture this same adoption data from these users and ensure these metrics are part of the offline license data sharing process.

In order to allow the offline cloud license usage export file to contain these add-on metrics, we will need to start tracking this as part of GitLab's historical license data.

Prerequisites

Consult with the following stakeholders first on the below proposal to ensure this will not negatively impact any other workflows that rely on this historical data

• grouputilization
• Data team

Proposal

• Add a new field named add_on_metrics to the HistoricalData table in GitLab
• The field should be of type jsonb and allow null values, which also aligns with the data structure for add_on_metrics for LicenseSeatLink records in CustomersDot. This column will also need a schema validation and an associated size limit (see https://docs.gitlab.com/development/migration_style_guide/#storing-json-in-database)
• Update database table doc description in db/docs/historical_data.yml
• Regression test the HistoricalDataWorker, current license usage exports and potentially other workflows highlighted by the above stakeholders to ensure no breaking changes occur