267 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Ruby
		
	
	
	
			
		
		
	
	
			267 lines
		
	
	
		
			11 KiB
		
	
	
	
		
			Ruby
		
	
	
	
# frozen_string_literal: true
 | 
						|
 | 
						|
module Gitlab
 | 
						|
  class UsageData
 | 
						|
    BATCH_SIZE = 100
 | 
						|
 | 
						|
    class << self
 | 
						|
      def data(force_refresh: false)
 | 
						|
        Rails.cache.fetch('usage_data', force: force_refresh, expires_in: 2.weeks) do
 | 
						|
          uncached_data
 | 
						|
        end
 | 
						|
      end
 | 
						|
 | 
						|
      def uncached_data
 | 
						|
        license_usage_data
 | 
						|
          .merge(system_usage_data)
 | 
						|
          .merge(features_usage_data)
 | 
						|
          .merge(components_usage_data)
 | 
						|
          .merge(cycle_analytics_usage_data)
 | 
						|
      end
 | 
						|
 | 
						|
      def to_json(force_refresh: false)
 | 
						|
        data(force_refresh: force_refresh).to_json
 | 
						|
      end
 | 
						|
 | 
						|
      def license_usage_data
 | 
						|
        usage_data = {
 | 
						|
          uuid: Gitlab::CurrentSettings.uuid,
 | 
						|
          hostname: Gitlab.config.gitlab.host,
 | 
						|
          version: Gitlab::VERSION,
 | 
						|
          installation_type: installation_type,
 | 
						|
          active_user_count: count(User.active),
 | 
						|
          recorded_at: Time.now,
 | 
						|
          edition: 'CE'
 | 
						|
        }
 | 
						|
 | 
						|
        usage_data
 | 
						|
      end
 | 
						|
 | 
						|
      # rubocop: disable Metrics/AbcSize
 | 
						|
      # rubocop: disable CodeReuse/ActiveRecord
 | 
						|
      def system_usage_data
 | 
						|
        {
 | 
						|
          counts: {
 | 
						|
            assignee_lists: count(List.assignee),
 | 
						|
            boards: count(Board),
 | 
						|
            ci_builds: count(::Ci::Build),
 | 
						|
            ci_internal_pipelines: count(::Ci::Pipeline.internal),
 | 
						|
            ci_external_pipelines: count(::Ci::Pipeline.external),
 | 
						|
            ci_pipeline_config_auto_devops: count(::Ci::Pipeline.auto_devops_source),
 | 
						|
            ci_pipeline_config_repository: count(::Ci::Pipeline.repository_source),
 | 
						|
            ci_runners: count(::Ci::Runner),
 | 
						|
            ci_triggers: count(::Ci::Trigger),
 | 
						|
            ci_pipeline_schedules: count(::Ci::PipelineSchedule),
 | 
						|
            auto_devops_enabled: count(::ProjectAutoDevops.enabled),
 | 
						|
            auto_devops_disabled: count(::ProjectAutoDevops.disabled),
 | 
						|
            deploy_keys: count(DeployKey),
 | 
						|
            deployments: count(Deployment),
 | 
						|
            successful_deployments: count(Deployment.success),
 | 
						|
            failed_deployments: count(Deployment.failed),
 | 
						|
            environments: count(::Environment),
 | 
						|
            clusters: count(::Clusters::Cluster),
 | 
						|
            clusters_enabled: count(::Clusters::Cluster.enabled),
 | 
						|
            project_clusters_enabled: count(::Clusters::Cluster.enabled.project_type),
 | 
						|
            group_clusters_enabled: count(::Clusters::Cluster.enabled.group_type),
 | 
						|
            clusters_disabled: count(::Clusters::Cluster.disabled),
 | 
						|
            project_clusters_disabled: count(::Clusters::Cluster.disabled.project_type),
 | 
						|
            group_clusters_disabled: count(::Clusters::Cluster.disabled.group_type),
 | 
						|
            clusters_platforms_eks: count(::Clusters::Cluster.aws_installed.enabled),
 | 
						|
            clusters_platforms_gke: count(::Clusters::Cluster.gcp_installed.enabled),
 | 
						|
            clusters_platforms_user: count(::Clusters::Cluster.user_provided.enabled),
 | 
						|
            clusters_applications_helm: count(::Clusters::Applications::Helm.available),
 | 
						|
            clusters_applications_ingress: count(::Clusters::Applications::Ingress.available),
 | 
						|
            clusters_applications_cert_managers: count(::Clusters::Applications::CertManager.available),
 | 
						|
            clusters_applications_crossplane: count(::Clusters::Applications::Crossplane.available),
 | 
						|
            clusters_applications_prometheus: count(::Clusters::Applications::Prometheus.available),
 | 
						|
            clusters_applications_runner: count(::Clusters::Applications::Runner.available),
 | 
						|
            clusters_applications_knative: count(::Clusters::Applications::Knative.available),
 | 
						|
            clusters_applications_elastic_stack: count(::Clusters::Applications::ElasticStack.available),
 | 
						|
            clusters_applications_jupyter: count(::Clusters::Applications::Jupyter.available),
 | 
						|
            in_review_folder: count(::Environment.in_review_folder),
 | 
						|
            grafana_integrated_projects: count(GrafanaIntegration.enabled),
 | 
						|
            groups: count(Group),
 | 
						|
            issues: count(Issue),
 | 
						|
            issues_created_from_gitlab_error_tracking_ui: count(SentryIssue),
 | 
						|
            issues_with_associated_zoom_link: count(ZoomMeeting.added_to_issue),
 | 
						|
            issues_using_zoom_quick_actions: distinct_count(ZoomMeeting, :issue_id),
 | 
						|
            issues_with_embedded_grafana_charts_approx: ::Gitlab::GrafanaEmbedUsageData.issue_count,
 | 
						|
            incident_issues: count(::Issue.authored(::User.alert_bot)),
 | 
						|
            keys: count(Key),
 | 
						|
            label_lists: count(List.label),
 | 
						|
            lfs_objects: count(LfsObject),
 | 
						|
            milestone_lists: count(List.milestone),
 | 
						|
            milestones: count(Milestone),
 | 
						|
            pages_domains: count(PagesDomain),
 | 
						|
            pool_repositories: count(PoolRepository),
 | 
						|
            projects: count(Project),
 | 
						|
            projects_imported_from_github: count(Project.where(import_type: 'github')),
 | 
						|
            projects_with_repositories_enabled: count(ProjectFeature.where('repository_access_level > ?', ProjectFeature::DISABLED)),
 | 
						|
            projects_with_error_tracking_enabled: count(::ErrorTracking::ProjectErrorTrackingSetting.where(enabled: true)),
 | 
						|
            projects_with_alerts_service_enabled: count(AlertsService.active),
 | 
						|
            protected_branches: count(ProtectedBranch),
 | 
						|
            releases: count(Release),
 | 
						|
            remote_mirrors: count(RemoteMirror),
 | 
						|
            snippets: count(Snippet),
 | 
						|
            suggestions: count(Suggestion),
 | 
						|
            todos: count(Todo),
 | 
						|
            uploads: count(Upload),
 | 
						|
            web_hooks: count(WebHook),
 | 
						|
            labels: count(Label),
 | 
						|
            merge_requests: count(MergeRequest),
 | 
						|
            notes: count(Note)
 | 
						|
          }.merge(
 | 
						|
            services_usage,
 | 
						|
            usage_counters,
 | 
						|
            user_preferences_usage,
 | 
						|
            ingress_modsecurity_usage
 | 
						|
          )
 | 
						|
        }
 | 
						|
      end
 | 
						|
      # rubocop: enable CodeReuse/ActiveRecord
 | 
						|
      # rubocop: enable Metrics/AbcSize
 | 
						|
 | 
						|
      def cycle_analytics_usage_data
 | 
						|
        Gitlab::CycleAnalytics::UsageData.new.to_json
 | 
						|
      rescue ActiveRecord::StatementInvalid
 | 
						|
        { avg_cycle_analytics: {} }
 | 
						|
      end
 | 
						|
 | 
						|
      def features_usage_data
 | 
						|
        features_usage_data_ce
 | 
						|
      end
 | 
						|
 | 
						|
      def features_usage_data_ce
 | 
						|
        {
 | 
						|
          container_registry_enabled: Gitlab.config.registry.enabled,
 | 
						|
          dependency_proxy_enabled: Gitlab.config.try(:dependency_proxy)&.enabled,
 | 
						|
          gitlab_shared_runners_enabled: Gitlab.config.gitlab_ci.shared_runners_enabled,
 | 
						|
          gravatar_enabled: Gitlab::CurrentSettings.gravatar_enabled?,
 | 
						|
          influxdb_metrics_enabled: Gitlab::Metrics.influx_metrics_enabled?,
 | 
						|
          ldap_enabled: Gitlab.config.ldap.enabled,
 | 
						|
          mattermost_enabled: Gitlab.config.mattermost.enabled,
 | 
						|
          omniauth_enabled: Gitlab::Auth.omniauth_enabled?,
 | 
						|
          prometheus_metrics_enabled: Gitlab::Metrics.prometheus_metrics_enabled?,
 | 
						|
          reply_by_email_enabled: Gitlab::IncomingEmail.enabled?,
 | 
						|
          signup_enabled: Gitlab::CurrentSettings.allow_signup?,
 | 
						|
          web_ide_clientside_preview_enabled: Gitlab::CurrentSettings.web_ide_clientside_preview_enabled?,
 | 
						|
          ingress_modsecurity_enabled: Feature.enabled?(:ingress_modsecurity)
 | 
						|
        }
 | 
						|
      end
 | 
						|
 | 
						|
      # @return [Hash<Symbol, Integer>]
 | 
						|
      def usage_counters
 | 
						|
        usage_data_counters.map(&:totals).reduce({}) { |a, b| a.merge(b) }
 | 
						|
      end
 | 
						|
 | 
						|
      # @return [Array<#totals>] An array of objects that respond to `#totals`
 | 
						|
      def usage_data_counters
 | 
						|
        [
 | 
						|
          Gitlab::UsageDataCounters::WikiPageCounter,
 | 
						|
          Gitlab::UsageDataCounters::WebIdeCounter,
 | 
						|
          Gitlab::UsageDataCounters::NoteCounter,
 | 
						|
          Gitlab::UsageDataCounters::SnippetCounter,
 | 
						|
          Gitlab::UsageDataCounters::SearchCounter,
 | 
						|
          Gitlab::UsageDataCounters::CycleAnalyticsCounter,
 | 
						|
          Gitlab::UsageDataCounters::ProductivityAnalyticsCounter,
 | 
						|
          Gitlab::UsageDataCounters::SourceCodeCounter,
 | 
						|
          Gitlab::UsageDataCounters::MergeRequestCounter
 | 
						|
        ]
 | 
						|
      end
 | 
						|
 | 
						|
      def components_usage_data
 | 
						|
        {
 | 
						|
          git: { version: Gitlab::Git.version },
 | 
						|
          gitaly: { version: Gitaly::Server.all.first.server_version, servers: Gitaly::Server.count, filesystems: Gitaly::Server.filesystems },
 | 
						|
          gitlab_pages: { enabled: Gitlab.config.pages.enabled, version: Gitlab::Pages::VERSION },
 | 
						|
          database: { adapter: Gitlab::Database.adapter_name, version: Gitlab::Database.version }
 | 
						|
        }
 | 
						|
      end
 | 
						|
 | 
						|
      def ingress_modsecurity_usage
 | 
						|
        ::Clusters::Applications::IngressModsecurityUsageService.new.execute
 | 
						|
      end
 | 
						|
 | 
						|
      # rubocop: disable CodeReuse/ActiveRecord
 | 
						|
      def services_usage
 | 
						|
        results = Service.available_services_names.without('jira').each_with_object({}) do |service_name, response|
 | 
						|
          response["projects_#{service_name}_active".to_sym] = count(Service.active.where(template: false, type: "#{service_name}_service".camelize))
 | 
						|
        end
 | 
						|
 | 
						|
        # Keep old Slack keys for backward compatibility, https://gitlab.com/gitlab-data/analytics/issues/3241
 | 
						|
        results[:projects_slack_notifications_active] = results[:projects_slack_active]
 | 
						|
        results[:projects_slack_slash_active] = results[:projects_slack_slash_commands_active]
 | 
						|
 | 
						|
        results.merge(jira_usage)
 | 
						|
      end
 | 
						|
 | 
						|
      def jira_usage
 | 
						|
        # Jira Cloud does not support custom domains as per https://jira.atlassian.com/browse/CLOUD-6999
 | 
						|
        # so we can just check for subdomains of atlassian.net
 | 
						|
 | 
						|
        results = {
 | 
						|
          projects_jira_server_active: 0,
 | 
						|
          projects_jira_cloud_active: 0,
 | 
						|
          projects_jira_active: -1
 | 
						|
        }
 | 
						|
 | 
						|
        Service.active
 | 
						|
          .by_type(:JiraService)
 | 
						|
          .includes(:jira_tracker_data)
 | 
						|
          .find_in_batches(batch_size: BATCH_SIZE) do |services|
 | 
						|
          counts = services.group_by do |service|
 | 
						|
            # TODO: Simplify as part of https://gitlab.com/gitlab-org/gitlab/issues/29404
 | 
						|
            service_url = service.data_fields&.url || (service.properties && service.properties['url'])
 | 
						|
            service_url&.include?('.atlassian.net') ? :cloud : :server
 | 
						|
          end
 | 
						|
 | 
						|
          results[:projects_jira_server_active] += counts[:server].count if counts[:server]
 | 
						|
          results[:projects_jira_cloud_active] += counts[:cloud].count if counts[:cloud]
 | 
						|
          if results[:projects_jira_active] == -1
 | 
						|
            results[:projects_jira_active] = services.size
 | 
						|
          else
 | 
						|
            results[:projects_jira_active] += services.size
 | 
						|
          end
 | 
						|
        end
 | 
						|
 | 
						|
        results
 | 
						|
      end
 | 
						|
      # rubocop: enable CodeReuse/ActiveRecord
 | 
						|
 | 
						|
      def user_preferences_usage
 | 
						|
        {} # augmented in EE
 | 
						|
      end
 | 
						|
 | 
						|
      def count(relation, column = nil, fallback: -1, batch: true)
 | 
						|
        if batch && Feature.enabled?(:usage_ping_batch_counter, default_enabled: true)
 | 
						|
          Gitlab::Database::BatchCount.batch_count(relation, column)
 | 
						|
        else
 | 
						|
          relation.count
 | 
						|
        end
 | 
						|
      rescue ActiveRecord::StatementInvalid
 | 
						|
        fallback
 | 
						|
      end
 | 
						|
 | 
						|
      def distinct_count(relation, column = nil, fallback: -1, batch: true)
 | 
						|
        if batch && Feature.enabled?(:usage_ping_batch_counter, default_enabled: true)
 | 
						|
          Gitlab::Database::BatchCount.batch_distinct_count(relation, column)
 | 
						|
        else
 | 
						|
          relation.distinct_count_by(column)
 | 
						|
        end
 | 
						|
      rescue ActiveRecord::StatementInvalid
 | 
						|
        fallback
 | 
						|
      end
 | 
						|
 | 
						|
      def installation_type
 | 
						|
        if Rails.env.production?
 | 
						|
          Gitlab::INSTALLATION_TYPE
 | 
						|
        else
 | 
						|
          "gitlab-development-kit"
 | 
						|
        end
 | 
						|
      end
 | 
						|
    end
 | 
						|
  end
 | 
						|
end
 | 
						|
 | 
						|
Gitlab::UsageData.prepend_if_ee('EE::Gitlab::UsageData')
 |