Commit 63cbe267 authored by Piotr Skorupa's avatar Piotr Skorupa Committed by Nikola Milojevic

Change data_category values to lowercase

parent 489a25f1
......@@ -2,10 +2,10 @@
module ServicePing
class PermitDataCategoriesService
STANDARD_CATEGORY = 'Standard'
SUBSCRIPTION_CATEGORY = 'Subscription'
OPERATIONAL_CATEGORY = 'Operational'
OPTIONAL_CATEGORY = 'Optional'
STANDARD_CATEGORY = 'standard'
SUBSCRIPTION_CATEGORY = 'subscription'
OPERATIONAL_CATEGORY = 'operational'
OPTIONAL_CATEGORY = 'optional'
CATEGORIES = [
STANDARD_CATEGORY,
SUBSCRIPTION_CATEGORY,
......
......@@ -59,7 +59,7 @@
},
"data_category": {
"type": "string",
"enum": ["Operational", "Optional", "Subscription", "Standard"]
"enum": ["Operational", "Optional", "Subscription", "Standard", "operational", "optional", "subscription", "standard"]
},
"instrumentation_class": {
"type": "string",
......
......@@ -37,7 +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`. The default value is `Optional`.|
| `data_category` | yes | `string`; [categories](#data-category) of the metric, may be set to `operational`, `optional`, `subscription`, `standard`. The default value is `optional`.|
| `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. |
| `performance_indicator_type` | no | `array`; may be set to one of [`gmau`, `smau`, `paid_gmau`, or `umau`](https://about.gitlab.com/handbook/business-technology/data-team/data-catalog/xmau-analysis/). |
......@@ -99,10 +99,10 @@ should be changed.
We use the following categories to classify a metric:
- `Operational`: Required data for operational purposes.
- `Optional`: Default value for a metric. Data that is optional to collect. This can be [enabled or disabled](../service_ping/index.md#disable-service-ping) in the Admin Area.
- `Subscription`: Data related to licensing.
- `Standard`: Standard set of identifiers that are included when collecting data.
- `operational`: Required data for operational purposes.
- `optional`: Default value for a metric. Data that is optional to collect. This can be [enabled or disabled](../service_ping/index.md#disable-service-ping) in the Admin Area.
- `subscription`: Data related to licensing.
- `standard`: Standard set of identifiers that are included when collecting data.
### Metric name suggestion examples
......
......@@ -13,7 +13,7 @@ RSpec.describe ServicePing::PermitDataCategoriesService do
end
it 'returns all categories' do
expect(permitted_categories).to match_array(%w[Standard Subscription Operational Optional])
expect(permitted_categories).to match_array(%w[standard subscription operational optional])
end
end
......@@ -41,7 +41,7 @@ RSpec.describe ServicePing::PermitDataCategoriesService do
end
it 'returns all categories' do
expect(permitted_categories).to match_array(%w[Standard Subscription Operational Optional])
expect(permitted_categories).to match_array(%w[standard subscription operational optional])
end
context 'when User.single_user&.requires_usage_stats_consent? is required' do
......@@ -62,7 +62,7 @@ RSpec.describe ServicePing::PermitDataCategoriesService do
end
it 'returns all categories' do
expect(permitted_categories).to match_array(%w[Standard Subscription Operational Optional])
expect(permitted_categories).to match_array(%w[standard subscription operational optional])
end
end
end
......@@ -80,7 +80,7 @@ RSpec.describe ServicePing::PermitDataCategoriesService do
end
it 'returns all categories' do
expect(permitted_categories).to match_array(%w[Standard Subscription Operational])
expect(permitted_categories).to match_array(%w[standard subscription operational])
end
end
......
......@@ -11,7 +11,7 @@ milestone: "<%= milestone %>"
introduced_by_url:
time_frame: <%= time_frame %>
data_source:
data_category: Optional
data_category: optional
performance_indicator_type:
distribution:
<%= distribution %>
......
......@@ -12,7 +12,7 @@ milestone: "13.9"
introduced_by_url:
time_frame: 7d
data_source:
data_category: Operational
data_category: operational
performance_indicator_type:
distribution:
- ce
......
......@@ -12,7 +12,7 @@ milestone: "13.9"
introduced_by_url:
time_frame: 7d
data_source:
data_category: Optional
data_category: optional
performance_indicator_type:
distribution:
- ee
......
......@@ -13,7 +13,7 @@ milestone: "13.9"
introduced_by_url:
time_frame: 7d
data_source:
data_category: Optional
data_category: optional
performance_indicator_type:
distribution:
- ce
......
......@@ -13,7 +13,7 @@ RSpec.describe Gitlab::Usage::Docs::Helper do
let(:metric_definition) do
{
data_category: 'Standard',
data_category: 'standard',
name: 'test_metric',
description: description,
product_group: 'group::product intelligence',
......@@ -66,7 +66,7 @@ RSpec.describe Gitlab::Usage::Docs::Helper do
end
describe '#render_data_category' do
let(:expected) { 'Data Category: `Standard`' }
let(:expected) { 'Data Category: `standard`' }
it { expect(helper.render_data_category(metric_definition)).to eq(expected) }
end
......
......@@ -18,7 +18,7 @@ RSpec.describe Gitlab::Usage::MetricDefinition do
distribution: %w(ee ce),
tier: %w(free starter premium ultimate bronze silver gold),
name: 'uuid',
data_category: 'Standard'
data_category: 'standard'
}
end
......@@ -199,7 +199,7 @@ RSpec.describe Gitlab::Usage::MetricDefinition do
data_source: 'database',
distribution: %w(ee ce),
tier: %w(free starter premium ultimate bronze silver gold),
data_category: 'Optional'
data_category: 'optional'
}
end
......
......@@ -4,7 +4,7 @@ require 'spec_helper'
RSpec.describe Gitlab::Usage::Metrics::Instrumentations::CollectedDataCategoriesMetric do
it_behaves_like 'a correct instrumented metric value', {} do
let(:expected_value) { %w[Standard Subscription Operational Optional] }
let(:expected_value) { %w[standard subscription operational optional] }
before do
allow_next_instance_of(ServicePing::PermitDataCategoriesService) do |instance|
......
......@@ -1080,7 +1080,7 @@ RSpec.describe Gitlab::UsageData, :aggregate_failures do
end
it 'reports collected data categories' do
expected_value = %w[Standard Subscription Operational Optional]
expected_value = %w[standard subscription operational optional]
allow_next_instance_of(ServicePing::PermitDataCategoriesService) do |instance|
expect(instance).to receive(:execute).and_return(expected_value)
......
......@@ -13,7 +13,7 @@ RSpec.describe ServicePing::PermitDataCategoriesService do
end
it 'returns all categories' do
expect(permitted_categories).to match_array(%w[Standard Subscription Operational Optional])
expect(permitted_categories).to match_array(%w[standard subscription operational optional])
end
end
......
......@@ -12,14 +12,14 @@ RSpec.shared_context 'stubbed service ping metrics definitions' do
let(:operational_metrics) do
[
metric_attributes('counts.merge_requests', "Operational"),
metric_attributes('counts.todos', "Operational")
metric_attributes('counts.merge_requests', "operational"),
metric_attributes('counts.todos', "operational")
]
end
let(:optional_metrics) do
[
metric_attributes('counts.boards', "Optional"),
metric_attributes('counts.boards', "optional"),
metric_attributes('gitaly.filesystems', '').except('data_category')
]
end
......
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