Commit 41762757 authored by Etienne Baqué's avatar Etienne Baqué

Merge branch '322557-add-system-as-a-data_source-for-metrics-definition' into 'master'

Add system as a data_source and update metric definitions

See merge request gitlab-org/gitlab!61011
parents 88409eef 3bcc2628
......@@ -10,7 +10,7 @@ status: data_available
milestone: "8.10"
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/557
time_frame: none
data_source: ruby
data_source: system
distribution:
- ee
- ce
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: ruby
data_source: system
instrumentation_class: 'Gitlab::Usage::Metrics::Instrumentations::HostnameMetric'
distribution:
- ce
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category:
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: ''
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -52,7 +52,7 @@
},
"data_source": {
"type": "string",
"enum": ["database", "redis", "redis_hll", "prometheus", "ruby"]
"enum": ["database", "redis", "redis_hll", "prometheus", "system"]
},
"instrumentation_class": {
"type": "string",
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ee
- ce
......
......@@ -8,7 +8,7 @@ product_category: auto_devops
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: runner
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: authentication_and_authorization
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category: onboarding
value_type: number
status: data_available
time_frame: all
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: web_firewall
value_type: boolean
status: deprecated
time_frame: none
data_source: database
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: global_search
value_type: boolean
status: data_available
time_frame: none
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: integrations
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -9,7 +9,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: operational_metrics
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -5,10 +5,10 @@ product_section: enablement
product_stage: enablement
product_group: group::memory
product_category: operational_metrics
value_type: number
value_type: string
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
- ee
......
......@@ -8,7 +8,7 @@ product_category: ''
value_type: number
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -8,7 +8,7 @@ product_category:
value_type: number
status: data_available
time_frame: all
data_source:
data_source: system
distribution:
- ce
tier:
......
......@@ -10,7 +10,7 @@ status: data_available
milestone: "13.10"
introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/54778
time_frame: none
data_source: ruby
data_source: system
distribution:
- ce
- ee
......
......@@ -6494,7 +6494,7 @@ Tiers: `free`, `premium`, `ultimate`
TBD
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216183248_pg_system_id.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216183248_pg_system_id.yml)
Group: `group::distribution`
......@@ -6590,7 +6590,7 @@ Tiers: `free`
Missing description
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216183241_filesystems.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216183241_filesystems.yml)
Group: ``
......@@ -6986,7 +6986,7 @@ Tiers: `free`, `premium`, `ultimate`
What Object Storage provider has been configured for Artifacts
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180843_provider.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180843_provider.yml)
Group: `group::memory`
......@@ -7046,7 +7046,7 @@ Tiers: `free`, `premium`, `ultimate`
What Object Storage provider has been configured for External Diffs
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180852_provider.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180852_provider.yml)
Group: `group::memory`
......@@ -7106,7 +7106,7 @@ Tiers: `free`, `premium`, `ultimate`
What Object Storage provider has been configured for LFS
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180902_provider.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180902_provider.yml)
Group: `group::memory`
......@@ -7166,7 +7166,7 @@ Tiers: `free`, `premium`, `ultimate`
What Object Storage provider has been configured for Packages
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180920_provider.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180920_provider.yml)
Group: `group::memory`
......@@ -7178,7 +7178,7 @@ Tiers: `free`, `premium`, `ultimate`
Whether Object Storage is enabled for Uploads
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180903_enabled.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180903_enabled.yml)
Group: `group::memory`
......@@ -7226,7 +7226,7 @@ Tiers: `free`, `premium`, `ultimate`
What Object Storage provider has been configured for Uploads
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216180911_provider.yml)
[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/settings/20210216180911_provider.yml)
Group: `group::memory`
......
......@@ -36,7 +36,7 @@ Each metric is defined in a separate YAML file consisting of a number of fields:
| `value_type` | yes | `string`; one of [`string`, `number`, `boolean`, `object`](https://json-schema.org/understanding-json-schema/reference/type.html). |
| `status` | yes | `string`; [status](#metric-statuses) of the metric, may be set to `data_available`, `implemented`, `not_used`, `deprecated`, `removed`. |
| `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`, `ruby`. |
| `data_source` | yes | `string`; may be set to a value like `database`, `redis`, `redis_hll`, `prometheus`, `system`. |
| `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. |
......@@ -121,10 +121,10 @@ only the single prompt to be replaced by the person working with metrics YAML.
`{subject}_{verb}{ing|ed}_{object}`, such as `user_creating_epics`, `users_triggering_security_scans`,
or `merge_requests_viewed_in_single_file_mode`
#### Metric with `data_source: prometheus` or `ruby`
#### Metric with `data_source: prometheus` or `system`
For metrics instrumented with Prometheus or Ruby, the suggested name includes only
the single prompt by person working with metrics YAML.
For metrics instrumented with Prometheus or coming from the operating system,
the suggested name includes only the single prompt by person working with metrics YAML.
- **Prompt**: `<please fill metric name>`
- **Final metric name**: Due to the variety of cases that can apply to this kind of metric,
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: string
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
......@@ -8,7 +8,7 @@ product_category: collection
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: global_search
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category: geo_replication
value_type: boolean
status: data_available
time_frame: none
data_source: database
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier:
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
......@@ -8,7 +8,7 @@ product_category:
value_type: boolean
status: data_available
time_frame: none
data_source:
data_source: system
distribution:
- ee
tier: []
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment