Merge branch 'psk-migrate-config-metrics-to-instrumentation-class' into 'master'

Migrate config metrics to instrumentation class

See merge request https://gitlab.com/gitlab-org/gitlab/-/merge_requests/135249



Merged-by: George Koltsov <gkoltsov@gitlab.com>
Approved-by: George Koltsov <gkoltsov@gitlab.com>
Reviewed-by: Radamanthus Batnag <rbatnag@gitlab.com>
Co-authored-by: Piotr Skorupa <pskorupa@gitlab.com>

config/metrics/settings/20210204124858_container_registry_enabled.yml

@@ -9,6 +9,10 @@ value_type: boolean
 status: active
 time_frame: none
 data_source: system
+instrumentation_class: GitlabConfigMetric
+options:
+  config:
+    registry: enabled
 distribution:
 - ee
 - ce

config/metrics/settings/20210204124900_dependency_proxy_enabled.yml

@@ -9,6 +9,10 @@ value_type: boolean
 status: active
 time_frame: none
 data_source: system
+instrumentation_class: GitlabConfigMetric
+options:
+  config:
+    dependency_proxy: enabled
 distribution:
 - ee
 - ce

config/metrics/settings/20210204124902_gitlab_shared_runners_enabled.yml

@@ -9,6 +9,10 @@ value_type: boolean
 status: active
 time_frame: none
 data_source: system
+instrumentation_class: GitlabConfigMetric
+options:
+  config:
+    gitlab_ci: shared_runners_enabled
 distribution:
 - ce
 - ee

config/metrics/settings/20210204124906_ldap_enabled.yml

@@ -9,6 +9,10 @@ value_type: boolean
 status: active
 time_frame: none
 data_source: system
+instrumentation_class: GitlabConfigMetric
+options:
+  config:
+    ldap: enabled
 distribution:
 - ce
 - ee

config/metrics/settings/20210204124908_mattermost_enabled.yml

@@ -9,6 +9,10 @@ value_type: boolean
 status: active
 time_frame: none
 data_source: system
+instrumentation_class: GitlabConfigMetric
+options:
+  config:
+    mattermost: enabled
 distribution:
 - ce
 - ee

lib/gitlab/usage/metrics/instrumentations/gitlab_config_metric.rb

+# frozen_string_literal: true
+
+module Gitlab
+  module Usage
+    module Metrics
+      module Instrumentations
+        class GitlabConfigMetric < GenericMetric
+          value do
+            method_name_array = config_hash_to_method_array(options[:config])
+
+            method_name_array.inject(Gitlab.config, :public_send)
+          end
+
+          private
+
+          def config_hash_to_method_array(object)
+            object.each_with_object([]) do |(key, value), result|
+              result.append(key)
+
+              if value.is_a?(Hash)
+                result.concat(config_hash_to_method_array(value))
+              else
+                result.append(value)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

lib/gitlab/usage_data.rb

@@ -163,11 +163,6 @@ def features_usage_data
 
       def features_usage_data_ce
         {
-          container_registry_enabled: alt_usage_data(fallback: nil) { Gitlab.config.registry.enabled },
-          dependency_proxy_enabled: Gitlab.config.try(:dependency_proxy)&.enabled,
-          gitlab_shared_runners_enabled: alt_usage_data(fallback: nil) { Gitlab.config.gitlab_ci.shared_runners_enabled },
-          ldap_enabled: alt_usage_data(fallback: nil) { Gitlab.config.ldap.enabled },
-          mattermost_enabled: alt_usage_data(fallback: nil) { Gitlab.config.mattermost.enabled },
           omniauth_enabled: alt_usage_data(fallback: nil) { Gitlab::Auth.omniauth_enabled? },
           prometheus_enabled: alt_usage_data(fallback: nil) { Gitlab::Prometheus::Internal.prometheus_enabled? },
           prometheus_metrics_enabled: alt_usage_data(fallback: nil) { Gitlab::Metrics.prometheus_metrics_enabled? },

spec/lib/gitlab/usage/metrics/instrumentations/gitlab_config_metric_spec.rb

+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Gitlab::Usage::Metrics::Instrumentations::GitlabConfigMetric, feature_category: :service_ping do
+  describe 'config metric' do
+    using RSpec::Parameterized::TableSyntax
+
+    where(:config_value, :expected_value) do
+      false | false
+      true  | true
+    end
+
+    with_them do
+      before do
+        stub_config(artifacts: { object_store: { enabled: config_value } })
+      end
+
+      it_behaves_like 'a correct instrumented metric value', {
+        time_frame: 'none',
+        options: {
+          config: {
+            artifacts: {
+              object_store: 'enabled'
+            }
+          }
+        }
+      }
+    end
+  end
+end

spec/lib/gitlab/usage_data_spec.rb

@@ -571,13 +571,8 @@ def omniauth_providers
       subject { described_class.features_usage_data_ce }
 
       it 'gathers feature usage data', :aggregate_failures do
-        expect(subject[:mattermost_enabled]).to eq(Gitlab.config.mattermost.enabled)
-        expect(subject[:ldap_enabled]).to eq(Gitlab.config.ldap.enabled)
         expect(subject[:omniauth_enabled]).to eq(Gitlab::Auth.omniauth_enabled?)
         expect(subject[:reply_by_email_enabled]).to eq(Gitlab::Email::IncomingEmail.enabled?)
-        expect(subject[:container_registry_enabled]).to eq(Gitlab.config.registry.enabled)
-        expect(subject[:dependency_proxy_enabled]).to eq(Gitlab.config.dependency_proxy.enabled)
-        expect(subject[:gitlab_shared_runners_enabled]).to eq(Gitlab.config.gitlab_ci.shared_runners_enabled)
       end
 
       context 'with embedded Prometheus' do

spec/support/helpers/usage_data_helpers.rb

@@ -77,13 +77,8 @@ module UsageDataHelpers
   USAGE_DATA_KEYS = %i[
     counts
     recorded_at
-    mattermost_enabled
-    ldap_enabled
     omniauth_enabled
     reply_by_email_enabled
-    container_registry_enabled
-    dependency_proxy_enabled
-    gitlab_shared_runners_enabled
     gitlab_pages
     git
     gitaly