usage_data.rb 9.5 KB
Newer Older
G
gfyoung 已提交
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)
A
Alex Kalderimis 已提交
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 20
          .merge(features_usage_data)
          .merge(components_usage_data)
          .merge(cycle_analytics_usage_data)
          .merge(usage_counters)
21 22
      end

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

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

        usage_data
      end

41
      # rubocop:disable Metrics/AbcSize
42
      # rubocop: disable CodeReuse/ActiveRecord
43 44 45
      def system_usage_data
        {
          counts: {
46 47 48 49 50 51 52 53 54 55 56 57 58 59
            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),
60 61
            successful_deployments: count(Deployment.success),
            failed_deployments: count(Deployment.failed),
62 63 64
            environments: count(::Environment),
            clusters: count(::Clusters::Cluster),
            clusters_enabled: count(::Clusters::Cluster.enabled),
65 66
            project_clusters_enabled: count(::Clusters::Cluster.enabled.project_type),
            group_clusters_enabled: count(::Clusters::Cluster.enabled.group_type),
67
            clusters_disabled: count(::Clusters::Cluster.disabled),
68 69
            project_clusters_disabled: count(::Clusters::Cluster.disabled.project_type),
            group_clusters_disabled: count(::Clusters::Cluster.disabled.group_type),
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 79 80 81 82 83 84 85 86
            in_review_folder: count(::Environment.in_review_folder),
            groups: count(Group),
            issues: count(Issue),
            keys: count(Key),
            label_lists: count(List.label),
            lfs_objects: count(LfsObject),
            milestone_lists: count(List.milestone),
            milestones: count(Milestone),
            pages_domains: count(PagesDomain),
87
            pool_repositories: count(PoolRepository),
88 89
            projects: count(Project),
            projects_imported_from_github: count(Project.where(import_type: 'github')),
90
            projects_with_repositories_enabled: count(ProjectFeature.where('repository_access_level > ?', ProjectFeature::DISABLED)),
L
Logan King 已提交
91
            projects_with_error_tracking_enabled: count(::ErrorTracking::ProjectErrorTrackingSetting.where(enabled: true)),
92 93 94 95
            protected_branches: count(ProtectedBranch),
            releases: count(Release),
            remote_mirrors: count(RemoteMirror),
            snippets: count(Snippet),
96 97
            suggestions: count(Suggestion),
            todos: count(Todo),
98 99
            uploads: count(Upload),
            web_hooks: count(WebHook)
100 101
          }.merge(services_usage)
            .merge(approximate_counts)
102
        }.tap do |data|
103
          data[:counts][:user_preferences] = user_preferences_usage
104
        end
105
      end
106
      # rubocop: enable CodeReuse/ActiveRecord
107

108
      def cycle_analytics_usage_data
109
        Gitlab::CycleAnalytics::UsageData.new.to_json
110 111
      end

112 113 114 115 116 117
      def features_usage_data
        features_usage_data_ce
      end

      def features_usage_data_ce
        {
118 119 120
          container_registry_enabled: Gitlab.config.registry.enabled,
          gitlab_shared_runners_enabled: Gitlab.config.gitlab_ci.shared_runners_enabled,
          gravatar_enabled: Gitlab::CurrentSettings.gravatar_enabled?,
121
          influxdb_metrics_enabled: Gitlab::Metrics.influx_metrics_enabled?,
122 123
          ldap_enabled: Gitlab.config.ldap.enabled,
          mattermost_enabled: Gitlab.config.mattermost.enabled,
124
          omniauth_enabled: Gitlab::Auth.omniauth_enabled?,
125
          prometheus_metrics_enabled: Gitlab::Metrics.prometheus_metrics_enabled?,
126 127
          reply_by_email_enabled: Gitlab::IncomingEmail.enabled?,
          signup_enabled: Gitlab::CurrentSettings.allow_signup?
S
Sean McGivern 已提交
128
        }
129
      end
130

A
Alex Kalderimis 已提交
131
      # @return [Hash<Symbol, Integer>]
T
Tiago Botelho 已提交
132
      def usage_counters
A
Alex Kalderimis 已提交
133 134 135 136 137
        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
138 139 140
        [
         Gitlab::UsageDataCounters::WikiPageCounter,
         Gitlab::UsageDataCounters::WebIdeCounter,
M
Mark Chao 已提交
141 142
         Gitlab::UsageDataCounters::NoteCounter,
         Gitlab::UsageDataCounters::SnippetCounter,
I
Igor 已提交
143
         Gitlab::UsageDataCounters::SearchCounter,
144
         Gitlab::UsageDataCounters::CycleAnalyticsCounter,
145
         Gitlab::UsageDataCounters::ProductivityAnalyticsCounter,
146 147
         Gitlab::UsageDataCounters::SourceCodeCounter,
         Gitlab::UsageDataCounters::MergeRequestCounter
148
        ]
T
Tiago Botelho 已提交
149 150
      end

151 152 153
      def components_usage_data
        {
          git: { version: Gitlab::Git.version },
154 155
          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 },
156 157
          database: { adapter: Gitlab::Database.adapter_name, version: Gitlab::Database.version }
        }
158
      end
159

160
      # rubocop: disable CodeReuse/ActiveRecord
161 162 163 164 165 166 167
      def services_usage
        types = {
          SlackService: :projects_slack_notifications_active,
          SlackSlashCommandsService: :projects_slack_slash_active,
          PrometheusService: :projects_prometheus_active
        }

168
        results = count(Service.unscoped.where(type: types.keys, active: true).group(:type), fallback: Hash.new(-1))
169
        types.each_with_object({}) { |(klass, key), response| response[key] = results[klass.to_s] || 0 }
170 171 172 173 174 175 176
          .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

177 178 179 180
        results = {
          projects_jira_server_active: 0,
          projects_jira_cloud_active: 0,
          projects_jira_active: -1
181
        }
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203

        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|
            # TODO: Simplify as part of https://gitlab.com/gitlab-org/gitlab-ce/issues/63084
            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
204
      end
205

206 207 208 209
      def user_preferences_usage
        {} # augmented in EE
      end

210 211
      def count(relation, count_by: nil, fallback: -1)
        count_by ? relation.count(count_by) : relation.count
212 213 214
      rescue ActiveRecord::StatementInvalid
        fallback
      end
215
      # rubocop: enable CodeReuse/ActiveRecord
216 217 218 219 220 221 222 223 224 225

      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
226 227 228 229 230 231 232 233

      def installation_type
        if Rails.env.production?
          Gitlab::INSTALLATION_TYPE
        else
          "gitlab-development-kit"
        end
      end
234 235 236
    end
  end
end
237 238

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