@@ -37,6 +37,7 @@ Each metric is defined in a separate YAML file consisting of a number of fields:
| `status` | yes | `string`; [status](#metric-statuses) of the metric, may be set to `data_available`, `implemented`, `not_used`, `deprecated`, `removed`, `broken`. |
| `time_frame` | yes | `string`; may be set to a value like `7d`, `28d`, `all`, `none`. |
| `data_source` | yes | `string`; may be set to a value like `database`, `redis`, `redis_hll`, `prometheus`, `system`. |
| `data_category` | yes | `string`; [categories](#data-category) of the metric, may be set to `Operational`, `Optional`, `Subscription`, `Standard`. |
| `instrumentation_class` | no | `string`; [the class that implements the metric](metrics_instrumentation.md). |
| `distribution` | yes | `array`; may be set to one of `ce, ee` or `ee`. The [distribution](https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/#definitions) where the tracked feature is available. |
| `tier` | yes | `array`; may be set to one of `free, premium, ultimate`, `premium, ultimate` or `ultimate`. The [tier](https://about.gitlab.com/handbook/marketing/strategic-marketing/tiers/) where the tracked feature is available. |
...
...
@@ -93,6 +94,15 @@ Metric name suggestions can contain two types of elements:
For a metric name to be valid, it must not include any prompt, and no fixed suggestions
should be changed.
### Data Category
We use the following categories to classify the metric.
1.`Operational`: Required data for operational purposes.
1.`Optional`: Data that is optional to collect. This can be enabled/disabled admin settings.
1.`Subscription`: Data related to licensing.
1.`Standard`: Data that is required to be collected.
