License usage

  • Tier: Premium, Ultimate
  • Offering: GitLab Self-Managed

You can view the usage associated with your GitLab license and export the license usage file or usage report file.

License usage file

You can export your license usage into a CSV file.

This file contains the information GitLab uses to manually process quarterly reconciliations and renewals. If your instance is firewalled or an offline environment, you must provide GitLab with this information.

The license usage file contains the following information:

  • License key
  • Licensee email
  • License start date (UTC)
  • License end date (UTC)
  • Company
  • Timestamp the file was generated at and exported (UTC)
  • Table of historical user counts for each day in the period:
    • Timestamp the count was recorded (UTC)
    • Billable user count

A custom format is used for dates and times in CSV files.

Export a license usage file

Prerequisites:

  • Administrator access.

To export your license usage file:

  1. In the upper-right corner, select Admin.
  2. In the left sidebar, select Subscription.
  3. In the upper-right corner, select Export license usage file.

Do not open the license usage file. If you open the file, failures might occur when you submit your license usage data.

Usage report

The availability of this feature is controlled by a feature flag. For more information, see the history. This feature is available for testing, but not ready for production use.

If your instance is in an offline environment, it cannot send usage data to GitLab. You should export a usage report instead, and upload it to Customers Portal within three days after the end of each month.

The usage report is a JSON file that covers one subscription term, from the term start date up to the last completed day. The report contains:

  • Your license key and instance details, like the instance ID, hostname, and GitLab version
  • The report start and end dates, and date and time when the report was generated (UTC)
  • Daily usage totals for each usage meter, like GitLab Duo Agent Platform flows and Secrets Manager
  • The highest billable user count for each day
  • The days with no recorded data. The report marks these days as unknown, not as zero usage.

The report contains only daily totals. It does not attribute usage to users, and contains no usernames, email addresses, or user IDs.

Each report covers the whole term, so if a report is not uploaded, the next report includes the same usage. GitLab records each day once, so days you’ve already uploaded are not counted twice.

When the usage report is available, Export usage report replaces Export license usage file on the Subscription page.

Export a usage report

Prerequisites:

  • Administrator access.
  • An instance activated with an offline license or a license file.

To export a usage report:

  1. In the upper-right corner, select Admin.
  2. In the left sidebar, select Subscription.
  3. In the upper-right corner, select Export usage report.
  4. Optional. If your subscription has renewed, from the Subscription term dropdown list, select the term to export. Export the previous term if you did not upload its last month.
  5. Review the report contents, then select Export JSON.
  6. Upload the downloaded file to the Customers Portal.