usage_data.rb 9.96 KB
Newer Older
1 2
# frozen_string_literal: true

3 4
module Gitlab
  class UsageData
5
    APPROXIMATE_COUNT_MODELS = [Label, MergeRequest, Note, Todo].freeze
6
    BATCH_SIZE = 100
7

8
    class << self
9
      def data(force_refresh: false)
Alex Kalderimis's avatar
Alex Kalderimis committed
10 11 12
        Rails.cache.fetch('usage_data', force: force_refresh, expires_in: 2.weeks) do
          uncached_data
        end
13 14 15 16
      end

      def uncached_data
        license_usage_data.merge(system_usage_data)
17 18 19
          .merge(features_usage_data)
          .merge(components_usage_data)
          .merge(cycle_analytics_usage_data)
20 21
      end

22 23
      def to_json(force_refresh: false)
        data(force_refresh: force_refresh).to_json
24 25
      end

26 27
      def license_usage_data
        usage_data = {
28
          uuid: Gitlab::CurrentSettings.uuid,
29 30
          hostname: Gitlab.config.gitlab.host,
          version: Gitlab::VERSION,
31
          installation_type: installation_type,
32
          active_user_count: count(User.active),
33 34 35 36 37 38 39
          recorded_at: Time.now,
          edition: 'CE'
        }

        usage_data
      end

40
      # rubocop: disable Metrics/AbcSize
41
      # rubocop: disable CodeReuse/ActiveRecord
42 43 44
      def system_usage_data
        {
          counts: {
45 46 47 48 49 50 51 52 53 54 55 56 57 58
            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),
59 60
            successful_deployments: count(Deployment.success),
            failed_deployments: count(Deployment.failed),
61 62 63
            environments: count(::Environment),
            clusters: count(::Clusters::Cluster),
            clusters_enabled: count(::Clusters::Cluster.enabled),
64 65
            project_clusters_enabled: count(::Clusters::Cluster.enabled.project_type),
            group_clusters_enabled: count(::Clusters::Cluster.enabled.group_type),
66
            clusters_disabled: count(::Clusters::Cluster.disabled),
67 68
            project_clusters_disabled: count(::Clusters::Cluster.disabled.project_type),
            group_clusters_disabled: count(::Clusters::Cluster.disabled.group_type),
69
            clusters_platforms_eks: count(::Clusters::Cluster.aws_installed.enabled),
70 71
            clusters_platforms_gke: count(::Clusters::Cluster.gcp_installed.enabled),
            clusters_platforms_user: count(::Clusters::Cluster.user_provided.enabled),
72 73 74 75 76 77
            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_prometheus: count(::Clusters::Applications::Prometheus.available),
            clusters_applications_runner: count(::Clusters::Applications::Runner.available),
            clusters_applications_knative: count(::Clusters::Applications::Knative.available),
78
            clusters_applications_elastic_stack: count(::Clusters::Applications::ElasticStack.available),
79 80 81
            in_review_folder: count(::Environment.in_review_folder),
            groups: count(Group),
            issues: count(Issue),
82 83
            issues_with_associated_zoom_link: count(ZoomMeeting.added_to_issue),
            issues_using_zoom_quick_actions: count(ZoomMeeting.select(:issue_id).distinct),
84 85 86 87 88 89
            keys: count(Key),
            label_lists: count(List.label),
            lfs_objects: count(LfsObject),
            milestone_lists: count(List.milestone),
            milestones: count(Milestone),
            pages_domains: count(PagesDomain),
90
            pool_repositories: count(PoolRepository),
91 92
            projects: count(Project),
            projects_imported_from_github: count(Project.where(import_type: 'github')),
93
            projects_with_repositories_enabled: count(ProjectFeature.where('repository_access_level > ?', ProjectFeature::DISABLED)),
94
            projects_with_error_tracking_enabled: count(::ErrorTracking::ProjectErrorTrackingSetting.where(enabled: true)),
95 96 97 98
            protected_branches: count(ProtectedBranch),
            releases: count(Release),
            remote_mirrors: count(RemoteMirror),
            snippets: count(Snippet),
99 100
            suggestions: count(Suggestion),
            todos: count(Todo),
101 102
            uploads: count(Upload),
            web_hooks: count(WebHook)
103 104 105 106 107 108 109
          }.merge(
            services_usage,
            approximate_counts,
            usage_counters,
            user_preferences_usage
          )
        }
110
      end
111
      # rubocop: enable CodeReuse/ActiveRecord
112
      # rubocop: enable Metrics/AbcSize
113

114
      def cycle_analytics_usage_data
115
        Gitlab::CycleAnalytics::UsageData.new.to_json
116 117
      end

118 119 120 121 122 123
      def features_usage_data
        features_usage_data_ce
      end

      def features_usage_data_ce
        {
124
          container_registry_enabled: Gitlab.config.registry.enabled,
125
          dependency_proxy_enabled: Gitlab.config.try(:dependency_proxy)&.enabled,
126 127
          gitlab_shared_runners_enabled: Gitlab.config.gitlab_ci.shared_runners_enabled,
          gravatar_enabled: Gitlab::CurrentSettings.gravatar_enabled?,
128
          influxdb_metrics_enabled: Gitlab::Metrics.influx_metrics_enabled?,
129 130
          ldap_enabled: Gitlab.config.ldap.enabled,
          mattermost_enabled: Gitlab.config.mattermost.enabled,
131
          omniauth_enabled: Gitlab::Auth.omniauth_enabled?,
132
          prometheus_metrics_enabled: Gitlab::Metrics.prometheus_metrics_enabled?,
133 134
          reply_by_email_enabled: Gitlab::IncomingEmail.enabled?,
          signup_enabled: Gitlab::CurrentSettings.allow_signup?
Sean McGivern's avatar
Sean McGivern committed
135
        }
136
      end
137

Alex Kalderimis's avatar
Alex Kalderimis committed
138
      # @return [Hash<Symbol, Integer>]
139
      def usage_counters
Alex Kalderimis's avatar
Alex Kalderimis committed
140 141 142 143 144
        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
145
        [
146 147 148 149 150 151 152 153 154
          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
155
        ]
156 157
      end

158 159 160
      def components_usage_data
        {
          git: { version: Gitlab::Git.version },
161 162
          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 },
163 164
          database: { adapter: Gitlab::Database.adapter_name, version: Gitlab::Database.version }
        }
165
      end
166

167
      # rubocop: disable CodeReuse/ActiveRecord
168 169 170 171 172 173 174
      def services_usage
        types = {
          SlackService: :projects_slack_notifications_active,
          SlackSlashCommandsService: :projects_slack_slash_active,
          PrometheusService: :projects_prometheus_active
        }

175
        results = count(Service.unscoped.where(type: types.keys, active: true).group(:type), fallback: Hash.new(-1))
176
        types.each_with_object({}) { |(klass, key), response| response[key] = results[klass.to_s] || 0 }
177 178 179 180 181 182 183
          .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

184 185 186 187
        results = {
          projects_jira_server_active: 0,
          projects_jira_cloud_active: 0,
          projects_jira_active: -1
188
        }
189 190 191 192 193 194 195

        Service.unscoped
          .where(type: :JiraService, active: true)
          .includes(:jira_tracker_data)
          .find_in_batches(batch_size: BATCH_SIZE) do |services|

          counts = services.group_by do |service|
196
            # TODO: Simplify as part of https://gitlab.com/gitlab-org/gitlab/issues/29404
197 198 199 200 201 202 203 204 205 206 207 208 209 210
            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] = count(services)
          else
            results[:projects_jira_active] += count(services)
          end
        end

        results
211
      end
212

213 214 215 216
      def user_preferences_usage
        {} # augmented in EE
      end

217 218
      def count(relation, count_by: nil, fallback: -1)
        count_by ? relation.count(count_by) : relation.count
219 220 221
      rescue ActiveRecord::StatementInvalid
        fallback
      end
222
      # rubocop: enable CodeReuse/ActiveRecord
223 224 225 226 227 228 229 230 231 232

      def approximate_counts
        approx_counts = Gitlab::Database::Count.approximate_counts(APPROXIMATE_COUNT_MODELS)

        APPROXIMATE_COUNT_MODELS.each_with_object({}) do |model, result|
          key = model.name.underscore.pluralize.to_sym

          result[key] = approx_counts[model] || -1
        end
      end
233 234 235 236 237 238 239 240

      def installation_type
        if Rails.env.production?
          Gitlab::INSTALLATION_TYPE
        else
          "gitlab-development-kit"
        end
      end
241 242 243
    end
  end
end
244 245

Gitlab::UsageData.prepend_if_ee('EE::Gitlab::UsageData')