Skip to content

Document Metrics definition statuses

Document status values for Metrics YAML definitions.

https://docs.gitlab.com/ee/development/usage_ping/metrics_dictionary.html

https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/schema.json#L27

Current values, some of this values are legacy from previous process and implementation of the Event Dictionary using spreadsheet:

    "status": {
      "type": ["string"],
      "enum": ["data_available", "planned", "in_progress", "implemented", "not_used", "deprecated"]
    },

Proposal

  • Remove usage of planned, in_progress this are legacy values since we were using Event Dictionary Spreadsheet

  • Add in docs when to use each status and what it means

  • data_available: When data is reaching in Sisense

  • implemented used when we add new metrics, this is short time, possible a milestone

  • not_used Metric is not used in any dashboard

  • deprecated: Metric is deprecated and possibly planned to be removed?

Might be we introduce more statuses if we find any relevant

cc @gitlab-org/growth/product-intelligence/engineers

The following discussion from !55782 (merged) should be addressed:

Edited by Alina Mihaila