Add Product Intelligence metrics definitions

  - Import metrics from events dictionary
  and usage ping
  - Metrics are set with skip_validation
  - Generate dictionary
  - Change value formatter, accept nil values
  - Fix naming in descriptions
  - Update initial metrics name with timestamp

config/metrics/counts_28d/deployments.yml → config/metrics/counts_28d/20210201124930_deployments.yml

+---
 key_path: counts_monthly.deployments
 description: Total deployments count for recent 28 days
+product_section: ops
 product_stage: release
-product_group: 'group::ops release'
-value_type: integer
+product_group: group::ops release
+product_category:
+value_type: number
 status: data_available
 milestone: 13.2
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35493
 time_frame: 28d
 data_source: database
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_7d/g_project_management_issue_title_changed_weekly.yml → config/metrics/counts_7d/20210201124931_g_project_management_issue_title_changed_weekly.yml

+---
 key_path: redis_hll_counters.issues_edit.g_project_management_issue_title_changed_weekly
 description: Distinct users count that changed issue title in a group for last recent week
 product_stage: plan
+product_group: group::project management
 product_category: issue_tracking
-value_type: integer
+value_type: number
 status: data_available
 milestone: 13.6
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/issues/229918
-product_group: 'group::project management'
 time_frame: 7d
 data_source: redis_hll
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate
+

config/metrics/counts_all/deployments.yml → config/metrics/counts_all/20210201124934_deployments.yml

+---
 key_path: counts.deployments
 description: Total deployments count
+product_section: ops
 product_stage: release
-product_group: 'group::ops release'
-value_type: integer
+product_group: group::ops release
+value_type: number
 status: data_available
 milestone: 8.12
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/735
 time_frame: all
 data_source: database
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate

config/metrics/counts_all/20210204124930_servers.yml

+---
+key_path: gitaly.servers
+description: Total Gitalty Servers
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: number
+status: data_available
+time_frame: all
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/counts_all/20210204124932_clusters.yml

+---
+key_path: gitaly.clusters
+description: Total GitLab Managed clusters both enabled and disabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: number
+status: data_available
+time_frame: all
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/license/recorded_at.yml → config/metrics/license/20210201124932_recorded_at.yml

+---
 key_path: recorded_at
 description: When the Usage Ping computation was started
 product_section: growth
@@ -10,5 +11,10 @@ milestone: 8.10
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/557
 time_frame: none
 data_source: ruby
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate

config/metrics/license/uuid.yml → config/metrics/license/20210201124933_uuid.yml

+---
 key_path: uuid
 description: GitLab instance unique identifier
 product_section: growth
@@ -10,5 +11,10 @@ milestone: 9.1
 introduced_by_url: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1521
 time_frame: none
 data_source: database
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate

config/metrics/license/20210204124827_hostname.yml

+---
+key_path: hostname
+description: Host name of GitLab instance
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate
+skip_validation: true

config/metrics/license/20210204124829_active_user_count.yml

+---
+key_path: active_user_count
+description: This is named the instance_user_count in the Versions application.
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source: database
+distribution:
+- ce
+- ee
+tier:
+- free
+- premium
+- ultimate
+skip_validation: true

config/metrics/license/20210204124854_license_management_jobs.yml

+---
+key_path: counts.license_management_jobs
+description: Name on the GitLab license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: number
+status: data_available
+time_frame: none
+data_source: database
+distribution: []
+tier:
+- premium
+- ultimate
+skip_validation: true

config/metrics/license/20210204124926_license_trial_ends_on.yml

+---
+key_path: license_trial_ends_on
+description: Date the license ends on
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/license/20210204124928_version.yml

+---
+key_path: gitaly.version
+description: Version of Gitaly
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/license/20210204124936_version.yml

+---
+key_path: gitlab_pages.version
+description: The version number of GitLab Pages
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/license/20210204124938_recording_ce_finished_at.yml

+---
+key_path: recording_ce_finished_at
+description: When the core features were computed
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ce
+- ee
+tier: []
+skip_validation: true

config/metrics/settings/database_adapter.yml → config/metrics/settings/20210201124935_database_adapter.yml

+---
 key_path: database.adapter
 description: This metric only returns a value of PostgreSQL in supported versions of GitLab. It could be removed from the usage ping. Historically MySQL was also supported.
-product_stage: growth
+product_section: enablement
+product_stage: enablement
 product_group: group::enablement distribution
 product_category: collection
 value_type: string
 status: data_available
 time_frame: none
 data_source: database
-distribution: [ee, ce]
-tier: ['free', 'starter', 'premium', 'ultimate', 'bronze', 'silver', 'gold']
+distribution:
+- ee
+- ce
+tier:
+- free
+- premium
+- ultimate

config/metrics/settings/20210204124856_instance_auto_devops_enabled.yml

+---
+key_path: instance_auto_devops_enabled
+description: Whether auto DevOps is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124858_container_registry_enabled.yml

+---
+key_path: container_registry_enabled
+description: Whether container registry is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124900_dependency_proxy_enabled.yml

+---
+key_path: dependency_proxy_enabled
+description: Whether dependency proxy is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124902_gitlab_shared_runners_enabled.yml

+---
+key_path: gitlab_shared_runners_enabled
+description: Whether shared runners is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124904_gravatar_enabled.yml

+---
+key_path: gravatar_enabled
+description: Whether gravatar is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124906_ldap_enabled.yml

+---
+key_path: ldap_enabled
+description: Whether LDAP is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124908_mattermost_enabled.yml

+---
+key_path: mattermost_enabled
+description: Whether Mattermost is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124910_omniauth_enabled.yml

+---
+key_path: omniauth_enabled
+description: Whether OmniAuth is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124912_prometheus_enabled.yml

+---
+key_path: prometheus_enabled
+description: Whether the bundled Prometheus is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124914_prometheus_metrics_enabled.yml

+---
+key_path: prometheus_metrics_enabled
+description: Whether Prometheus Metrics endpoint is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124916_reply_by_email_enabled.yml

+---
+key_path: reply_by_email_enabled
+description: Whether incoming email is setup
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124918_signup_enabled.yml

+---
+key_path: signup_enabled
+description: Whether public signup is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124920_web_ide_clientside_preview_enabled.yml

+---
+key_path: web_ide_clientside_preview_enabled
+description: Whether web ide clientside preview is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124922_grafana_link_enabled.yml

+---
+key_path: grafana_link_enabled
+description: Whether Grafana is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124924_elasticsearch_enabled.yml

+---
+key_path: elasticsearch_enabled
+description: Whether Elasticsearch is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

config/metrics/settings/20210204124934_enabled.yml

+---
+key_path: gitlab_pages.enabled
+description: Whether GitLab Pages is enabled
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution: []
+tier: []
+skip_validation: true

ee/config/metrics/counts_all/geo_nodes.yml → ee/config/metrics/counts_all/20210201124936_geo_nodes.yml

 key_path: counts.geo_nodes
 description: Total number of sites in a Geo deployment
+product_section: enablement
 product_stage: enablement
+product_group: group::geo
 product_category: disaster_recovery
 value_type: integer
 status: data_available
 milestone: 11.2
-product_group: 'group::geo'
 time_frame: all
 data_source: database
-distribution: [ee]
-tier: ['premium', 'ultimate']
+distribution:
+- ee
+tier:
+- premium
+- ultimate

ee/config/metrics/license/20210204124831_license_md5.yml

+---
+key_path: license_md5
+description: The license key of the GitLab instance
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- free
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124833_license_id.yml

+---
+key_path: license_id
+description: The ID of the license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124835_historical_max_users.yml

+---
+key_path: historical_max_users
+description: The maximum active user count. Active is defined in UsersStatistics model.
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124837_name.yml

+---
+key_path: licensee.Name
+description: Name on the GitLab license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124839_email.yml

+---
+key_path: licensee.Email
+description: Email on the GitLab license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124841_company.yml

+---
+key_path: licensee.Company
+description: Company on the GitLab license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124843_license_user_count.yml

+---
+key_path: license_user_count
+description: The number of users included in the license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source: database
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124845_license_starts_at.yml

+---
+key_path: license_starts_at
+description: The date the license starts
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124847_license_expires_at.yml

+---
+key_path: license_expires_at
+description: The date the license ends
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124849_license_plan.yml

+---
+key_path: license_plan
+description: The plan of the GitLab license
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124852_license_subscription_id.yml

+---
+key_path: license_subscription_id
+description: Licese zuora_subscription_id
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

ee/config/metrics/license/20210204124940_recording_ee_finished_at.yml

+---
+key_path: recording_ee_finished_at
+description: When the EE-specific features were computed
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: string
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier: []
+skip_validation: true

ee/config/metrics/settings/20210204124851_license_trial.yml

+---
+key_path: license_trial
+description: Whether this is a trial license or not
+product_section: growth
+product_stage: growth
+product_group: group::product intelligence
+product_category: collection
+value_type: boolean
+status: data_available
+time_frame: none
+data_source:
+distribution:
+- ee
+tier:
+- premium
+- ultimate
+skip_validation: true

lib/gitlab/usage/docs/helper.rb

@@ -27,7 +27,7 @@ module Gitlab
         end
 
         def render_name(name)
-          "## #{name}\n"
+          "## `#{name}`\n"
         end
 
         def render_description(object)

lib/gitlab/usage/docs/value_formatter.rb

@@ -7,9 +7,9 @@ module Gitlab
         def self.format(key, value)
           case key
           when :key_path
-            "**#{value}**"
+            "**`#{value}`**"
           when :data_source
-            value.capitalize
+            value.to_s.capitalize
           when :product_group
             "`#{value}`"
           when :introduced_by_url

spec/lib/gitlab/usage/docs/renderer_spec.rb

@@ -14,6 +14,7 @@ RSpec.describe Gitlab::Usage::Docs::Renderer do
         .table_of_contents
         .select { |metric_doc| metric_doc.level == 2 && !metric_doc.text.start_with?('info:') }
         .map(&:text)
+        .map { |text| text.sub('<code>', '').sub('</code>', '') }
 
       expect(generated_dictionary_keys).to match_array(items.keys)
     end

spec/lib/gitlab/usage/docs/value_formatter_spec.rb

@@ -12,7 +12,7 @@ RSpec.describe Gitlab::Usage::Docs::ValueFormatter do
       :introduced_by_url | 'http://test.com'              | '[Introduced by](http://test.com)'
       :tier              | %w(gold premium)               | 'gold, premium'
       :distribution      | %w(ce ee)                      | 'ce, ee'
-      :key_path          | 'key.path'                     | '**key.path**'
+      :key_path          | 'key.path'                     | '**`key.path`**'
       :milestone         | '13.4'                         | '13.4'
       :status            | 'data_available'               | 'data_available'
     end