Class: Gitlab::UsageData

Inherits:
Object
  • Object
show all
Extended by:
Gitlab::Usage::TimeFrame, Gitlab::Utils::StrongMemoize, Gitlab::Utils::UsageData
Defined in:
lib/gitlab/usage_data.rb,
lib/gitlab/usage_data/topology.rb

Defined Under Namespace

Classes: Topology

Constant Summary collapse

MAX_GENERATION_TIME_FOR_SAAS =
40.hours
CE_MEMOIZED_VALUES =
%i(
  issue_minimum_id
  issue_maximum_id
  project_minimum_id
  project_maximum_id
  user_minimum_id
  user_maximum_id
  deployment_minimum_id
  deployment_maximum_id
  auth_providers
  aggregated_metrics
  recorded_at
).freeze

Constants included from Gitlab::Usage::TimeFrame

Gitlab::Usage::TimeFrame::ALL_TIME_TIME_FRAME_NAME, Gitlab::Usage::TimeFrame::SEVEN_DAYS_TIME_FRAME_NAME, Gitlab::Usage::TimeFrame::TWENTY_EIGHT_DAYS_TIME_FRAME_NAME

Constants included from Gitlab::Utils::UsageData

Gitlab::Utils::UsageData::DISTRIBUTED_HLL_FALLBACK, Gitlab::Utils::UsageData::FALLBACK, Gitlab::Utils::UsageData::HISTOGRAM_FALLBACK, Gitlab::Utils::UsageData::MAX_BUCKET_SIZE

Class Method Summary collapse

Methods included from Gitlab::Usage::TimeFrame

monthly_time_range, monthly_time_range_db_params, weekly_time_range

Methods included from Gitlab::Utils::StrongMemoize

clear_memoization, strong_memoize, strong_memoized?

Methods included from Gitlab::Utils::UsageData

add, add_metric, alt_usage_data, average, count, distinct_count, epics_deepest_relationship_level, estimate_batch_distinct_count, histogram, jira_integration_data, maximum_id, measure_duration, minimum_id, redis_usage_data, sum, track_usage_event, with_duration, with_finished_at, with_prometheus_client

Class Method Details

.action_monthly_active_users(time_period) ⇒ Object


646
647
648
649
650
651
# File 'lib/gitlab/usage_data.rb', line 646

def action_monthly_active_users(time_period)
  date_range = { date_from: time_period[:created_at].first, date_to: time_period[:created_at].last }

  event_monthly_active_users(date_range)
    .merge!(ide_monthly_active_users(date_range))
end

.aggregated_metrics_dataObject


636
637
638
639
640
641
642
643
644
# File 'lib/gitlab/usage_data.rb', line 636

def aggregated_metrics_data
  {
    counts_weekly: { aggregated_metrics: aggregated_metrics.weekly_data },
    counts_monthly: { aggregated_metrics: aggregated_metrics.monthly_data },
    counts: aggregated_metrics
              .all_time_data
              .to_h { |key, value| ["aggregate_#{key}".to_sym, value.round] }
  }
end

.components_usage_dataObject


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
# File 'lib/gitlab/usage_data.rb', line 274

def components_usage_data
  {
    git: { version: alt_usage_data(fallback: { major: -1 }) { Gitlab::Git.version } },
    gitaly: {
      version: alt_usage_data { Gitaly::Server.all.first.server_version },
      servers: alt_usage_data { Gitaly::Server.count },
      clusters: alt_usage_data { Gitaly::Server.gitaly_clusters },
      filesystems: alt_usage_data(fallback: ["-1"]) { Gitaly::Server.filesystems }
    },
    gitlab_pages: {
      enabled: alt_usage_data(fallback: nil) { Gitlab.config.pages.enabled },
      version: alt_usage_data { Gitlab::Pages::VERSION }
    },
    container_registry_server: {
      vendor: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.container_registry_vendor },
      version: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.container_registry_version }
    },
    database: {
      # rubocop: disable UsageData/LargeTable
      adapter: alt_usage_data { ApplicationRecord.database.adapter_name },
      version: alt_usage_data { ApplicationRecord.database.version },
      pg_system_id: alt_usage_data { ApplicationRecord.database.system_id },
      flavor: alt_usage_data { ApplicationRecord.database.flavor }
      # rubocop: enable UsageData/LargeTable
    },
    mail: {
      smtp_server: alt_usage_data { ActionMailer::Base.smtp_settings[:address] }
    }
  }
end

.container_expiration_policies_usageObject

rubocop: disable CodeReuse/ActiveRecord


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
# File 'lib/gitlab/usage_data.rb', line 344

def container_expiration_policies_usage
  results = {}
  start = minimum_id(Project)
  finish = maximum_id(Project)

  results[:projects_with_expiration_policy_disabled] = distinct_count(::ContainerExpirationPolicy.where(enabled: false), :project_id, start: start, finish: finish)
  # rubocop: disable UsageData/LargeTable
  base = ::ContainerExpirationPolicy.active
  # rubocop: enable UsageData/LargeTable
  results[:projects_with_expiration_policy_enabled] = distinct_count(base, :project_id, start: start, finish: finish)

  # rubocop: disable UsageData/LargeTable
  %i[keep_n cadence older_than].each do |option|
    ::ContainerExpirationPolicy.public_send("#{option}_options").keys.each do |value| # rubocop: disable GitlabSecurity/PublicSend
      results["projects_with_expiration_policy_enabled_with_#{option}_set_to_#{value}".to_sym] = distinct_count(base.where(option => value), :project_id, start: start, finish: finish)
    end
  end
  # rubocop: enable UsageData/LargeTable

  results[:projects_with_expiration_policy_enabled_with_keep_n_unset] = distinct_count(base.where(keep_n: nil), :project_id, start: start, finish: finish)
  results[:projects_with_expiration_policy_enabled_with_older_than_unset] = distinct_count(base.where(older_than: nil), :project_id, start: start, finish: finish)

  results
end

.dataObject


42
43
44
45
46
47
48
# File 'lib/gitlab/usage_data.rb', line 42

def data
  clear_memoized

  with_finished_at(:recording_ce_finished_at) do
    usage_data_metrics
  end
end

.features_usage_dataObject

rubocop: enable CodeReuse/ActiveRecord


240
241
242
# File 'lib/gitlab/usage_data.rb', line 240

def features_usage_data
  features_usage_data_ce
end

.features_usage_data_ceObject


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
# File 'lib/gitlab/usage_data.rb', line 244

def features_usage_data_ce
  {
    instance_auto_devops_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.auto_devops_enabled? },
    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 },
    gravatar_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.gravatar_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? },
    reply_by_email_enabled: alt_usage_data(fallback: nil) { Gitlab::IncomingEmail.enabled? },
    signup_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.allow_signup? },
    web_ide_clientside_preview_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.web_ide_clientside_preview_enabled? },
    grafana_link_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.grafana_enabled? },
    gitpod_enabled: alt_usage_data(fallback: nil) { Gitlab::CurrentSettings.gitpod_enabled? }
  }
end

.grafana_embed_usage_dataObject

rubocop:disable CodeReuse/ActiveRecord


233
234
235
236
237
# File 'lib/gitlab/usage_data.rb', line 233

def grafana_embed_usage_data
  count(Issue.joins('JOIN grafana_integrations USING (project_id)')
    .where("issues.description LIKE '%' || grafana_integrations.grafana_url || '%'")
    .where(grafana_integrations: { enabled: true }))
end

.installation_typeObject


446
447
448
449
450
451
452
# File 'lib/gitlab/usage_data.rb', line 446

def installation_type
  if Rails.env.production?
    Gitlab::INSTALLATION_TYPE
  else
    "gitlab-development-kit"
  end
end

.integrations_usageObject


369
370
371
372
373
374
375
376
377
378
379
380
381
# File 'lib/gitlab/usage_data.rb', line 369

def integrations_usage
  # rubocop: disable UsageData/LargeTable:
  Integration.available_integration_names(include_dev: false).each_with_object({}) do |name, response|
    type = Integration.integration_name_to_type(name)

    response[:"projects_#{name}_active"] = count(Integration.active.where.not(project: nil).where(type: type))
    response[:"groups_#{name}_active"] = count(Integration.active.where.not(group: nil).where(type: type))
    response[:"instances_#{name}_active"] = count(Integration.active.where(instance: true, type: type))
    response[:"projects_inheriting_#{name}_active"] = count(Integration.active.where.not(project: nil).where.not(inherit_from_id: nil).where(type: type))
    response[:"groups_inheriting_#{name}_active"] = count(Integration.active.where.not(group: nil).where.not(inherit_from_id: nil).where(type: type))
  end.merge(jira_usage, jira_import_usage)
  # rubocop: enable UsageData/LargeTable:
end

.jira_import_usageObject

rubocop: enable CodeReuse/ActiveRecord


404
405
406
407
408
409
410
411
412
413
414
# File 'lib/gitlab/usage_data.rb', line 404

def jira_import_usage
  # rubocop: disable UsageData/LargeTable
  finished_jira_imports = JiraImportState.finished

  {
    jira_imports_total_imported_count: count(finished_jira_imports),
    jira_imports_projects_count: distinct_count(finished_jira_imports, :project_id),
    jira_imports_total_imported_issues_count: add_metric('JiraImportsTotalImportedIssuesCountMetric')
  }
  # rubocop: enable UsageData/LargeTable
end

.jira_usageObject


383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
# File 'lib/gitlab/usage_data.rb', line 383

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_dvcs_cloud_active: count(ProjectFeatureUsage.with_jira_dvcs_integration_enabled),
    projects_jira_dvcs_server_active: count(ProjectFeatureUsage.with_jira_dvcs_integration_enabled(cloud: false))
  }

  jira_integration_data_hash = jira_integration_data
  results[:projects_jira_server_active] = jira_integration_data_hash[:projects_jira_server_active]
  results[:projects_jira_cloud_active] = jira_integration_data_hash[:projects_jira_cloud_active]

  results
rescue ActiveRecord::StatementInvalid => error
  Gitlab::ErrorTracking.track_and_raise_for_dev_exception(error)
  { projects_jira_server_active: FALLBACK, projects_jira_cloud_active: FALLBACK }
end

.license_usage_dataObject


50
51
52
53
54
55
56
57
58
59
60
# File 'lib/gitlab/usage_data.rb', line 50

def license_usage_data
  {
    recorded_at: recorded_at,
    uuid: add_metric('UuidMetric'),
    hostname: add_metric('HostnameMetric'),
    version: alt_usage_data { Gitlab::VERSION },
    installation_type: alt_usage_data { installation_type },
    active_user_count: add_metric('ActiveUserCountMetric'),
    edition: 'CE'
  }
end

.merge_requests_users(time_period) ⇒ Object


434
435
436
437
438
439
440
441
442
443
444
# File 'lib/gitlab/usage_data.rb', line 434

def merge_requests_users(time_period)
  counter = Gitlab::UsageDataCounters::TrackUniqueEvents

  redis_usage_data do
    counter.count_unique_events(
      event_action: Gitlab::UsageDataCounters::TrackUniqueEvents::MERGE_REQUEST_ACTION,
      date_from: time_period[:created_at].first,
      date_to: time_period[:created_at].last
    )
  end
end

.object_store_config(component) ⇒ Object


305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/gitlab/usage_data.rb', line 305

def object_store_config(component)
  config = alt_usage_data(fallback: nil) do
    Settings[component]['object_store']
  end

  if config.present?
    {
      enabled: alt_usage_data { Settings[component]['enabled'] },
      object_store: {
        enabled: alt_usage_data { config['enabled'] },
        direct_upload: alt_usage_data { config['direct_upload'] },
        background_upload: alt_usage_data { config['background_upload'] },
        provider: alt_usage_data { config['connection']['provider'] }
      }
    }
  else
    {
      enabled: alt_usage_data { Settings[component]['enabled'] }
    }
  end
end

.object_store_usage_dataObject


327
328
329
330
331
332
333
334
335
336
337
# File 'lib/gitlab/usage_data.rb', line 327

def object_store_usage_data
  {
    object_store: {
      artifacts: object_store_config('artifacts'),
      external_diffs: object_store_config('external_diffs'),
      lfs: object_store_config('lfs'),
      uploads: object_store_config('uploads'),
      packages: object_store_config('packages')
    }
  }
end

.operating_systemObject


454
455
456
457
458
459
460
461
462
463
# File 'lib/gitlab/usage_data.rb', line 454

def operating_system
  ohai_data = Ohai::System.new.tap do |oh|
    oh.all_plugins(['platform'])
  end.data

  platform = ohai_data['platform']
  platform = 'raspbian' if ohai_data['platform'] == 'debian' && /armv/.match?(ohai_data['kernel']['machine'])

  "#{platform}-#{ohai_data['platform_version']}"
end

.recorded_atObject


62
63
64
# File 'lib/gitlab/usage_data.rb', line 62

def recorded_at
  @recorded_at ||= Time.current
end

.redis_hll_countersObject


632
633
634
# File 'lib/gitlab/usage_data.rb', line 632

def redis_hll_counters
  { redis_hll_counters: ::Gitlab::UsageDataCounters::HLLRedisCounter.unique_events_data }
end

.runners_usageObject

rubocop: enable Metrics/AbcSize


172
173
174
175
176
177
178
179
180
181
182
# File 'lib/gitlab/usage_data.rb', line 172

def runners_usage
  {
    ci_runners: count(::Ci::Runner),
    ci_runners_instance_type_active: count(::Ci::Runner.instance_type.active),
    ci_runners_group_type_active: count(::Ci::Runner.group_type.active),
    ci_runners_project_type_active: count(::Ci::Runner.project_type.active),
    ci_runners_instance_type_active_online: count(::Ci::Runner.instance_type.active.online),
    ci_runners_group_type_active_online: count(::Ci::Runner.group_type.active.online),
    ci_runners_project_type_active_online: count(::Ci::Runner.project_type.active.online)
  }
end

.successful_deployments_with_cluster(scope) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord rubocop: disable UsageData/LargeTable


418
419
420
421
422
423
# File 'lib/gitlab/usage_data.rb', line 418

def successful_deployments_with_cluster(scope)
  scope
    .joins(cluster: :deployments)
    .merge(::Clusters::Cluster.enabled)
    .merge(Deployment.success)
end

.system_usage_dataObject

rubocop: disable Metrics/AbcSize rubocop: disable CodeReuse/ActiveRecord


68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
# File 'lib/gitlab/usage_data.rb', line 68

def system_usage_data
  issues_created_manually_from_alerts = if Gitlab.com?
                                          FALLBACK
                                        else
                                          count(Issue.with_alert_management_alerts.not_authored_by(::User.alert_bot), start: minimum_id(Issue), finish: maximum_id(Issue))
                                        end

  {
    counts: {
      assignee_lists: count(List.assignee),
      ci_builds: count(::Ci::Build),
      ci_internal_pipelines: Gitlab.com? ? FALLBACK : 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_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),
      # rubocop: disable UsageData/LargeTable:
      deployments: deployment_count(Deployment),
      successful_deployments: deployment_count(Deployment.success),
      failed_deployments: deployment_count(Deployment.failed),
      feature_flags: count(Operations::FeatureFlag),
      # rubocop: enable UsageData/LargeTable:
      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),
      instance_clusters_enabled: count(::Clusters::Cluster.enabled.instance_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),
      instance_clusters_disabled: count(::Clusters::Cluster.disabled.instance_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_management_project: count(::Clusters::Cluster.with_management_project),
      clusters_integrations_prometheus: count(::Clusters::Integrations::Prometheus.enabled),
      kubernetes_agents: count(::Clusters::Agent),
      kubernetes_agents_with_token: distinct_count(::Clusters::AgentToken, :agent_id),
      in_review_folder: count(::Environment.in_review_folder),
      grafana_integrated_projects: count(GrafanaIntegration.enabled),
      groups: count(Group),
      issues: add_metric('CountIssuesMetric', time_frame: 'all'),
      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: grafana_embed_usage_data,
      issues_created_from_alerts: total_alert_issues,
      issues_created_gitlab_alerts: issues_created_manually_from_alerts,
      issues_created_manually_from_alerts: issues_created_manually_from_alerts,
      incident_issues: count(::Issue.incident, start: minimum_id(Issue), finish: maximum_id(Issue)),
      alert_bot_incident_issues: count(::Issue.authored(::User.alert_bot), start: minimum_id(Issue), finish: maximum_id(Issue)),
      keys: count(Key),
      label_lists: count(List.label),
      lfs_objects: count(LfsObject),
      milestone_lists: count(List.milestone),
      milestones: count(Milestone),
      projects_with_packages: distinct_count(::Packages::Package, :project_id),
      packages: count(::Packages::Package),
      pages_domains: count(PagesDomain),
      pool_repositories: count(PoolRepository),
      projects: count(Project),
      projects_creating_incidents: distinct_count(Issue.incident, :project_id),
      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_created: distinct_count(::AlertManagement::Alert, :project_id),
      projects_with_enabled_alert_integrations: distinct_count(::AlertManagement::HttpIntegration.active, :project_id),
      projects_with_terraform_reports: distinct_count(::Ci::JobArtifact.terraform_reports, :project_id),
      projects_with_terraform_states: distinct_count(::Terraform::State, :project_id),
      protected_branches: count(ProtectedBranch),
      protected_branches_except_default: count(ProtectedBranch.where.not(name: ['main', 'master', Gitlab::CurrentSettings.default_branch_name])),
      releases: count(Release),
      remote_mirrors: count(RemoteMirror),
      personal_snippets: count(PersonalSnippet),
      project_snippets: count(ProjectSnippet),
      suggestions: count(Suggestion),
      terraform_reports: count(::Ci::JobArtifact.terraform_reports),
      terraform_states: count(::Terraform::State),
      todos: count(Todo),
      uploads: count(Upload),
      web_hooks: count(WebHook),
      labels: count(Label),
      merge_requests: count(MergeRequest),
      notes: count(Note)
    }.merge(
      runners_usage,
      integrations_usage,
      usage_counters,
      user_preferences_usage,
      container_expiration_policies_usage,
      service_desk_counts,
      email_campaign_counts
    ).tap do |data|
      data[:snippets] = add(data[:personal_snippets], data[:project_snippets])
    end
  }
end

.system_usage_data_licenseObject

rubocop: enable CodeReuse/ActiveRecord


204
205
206
207
208
# File 'lib/gitlab/usage_data.rb', line 204

def system_usage_data_license
  {
    license: {}
  }
end

.system_usage_data_monthlyObject


184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
# File 'lib/gitlab/usage_data.rb', line 184

def system_usage_data_monthly
  {
    counts_monthly: {
      # rubocop: disable UsageData/LargeTable:
      deployments: deployment_count(Deployment.where(monthly_time_range_db_params)),
      successful_deployments: deployment_count(Deployment.success.where(monthly_time_range_db_params)),
      failed_deployments: deployment_count(Deployment.failed.where(monthly_time_range_db_params)),
      # rubocop: enable UsageData/LargeTable:
      projects: count(Project.where(monthly_time_range_db_params), start: minimum_id(Project), finish: maximum_id(Project)),
      packages: count(::Packages::Package.where(monthly_time_range_db_params)),
      personal_snippets: count(PersonalSnippet.where(monthly_time_range_db_params)),
      project_snippets: count(ProjectSnippet.where(monthly_time_range_db_params)),
      projects_with_alerts_created: distinct_count(::AlertManagement::Alert.where(monthly_time_range_db_params), :project_id)
    }.tap do |data|
      data[:snippets] = add(data[:personal_snippets], data[:project_snippets])
    end
  }
end

.system_usage_data_settingsObject


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
# File 'lib/gitlab/usage_data.rb', line 210

def system_usage_data_settings
  {
    settings: {
      ldap_encrypted_secrets_enabled: alt_usage_data(fallback: nil) { Gitlab::Auth::Ldap::Config.encrypted_secrets.active? },
      smtp_encrypted_secrets_enabled: alt_usage_data(fallback: nil) { Gitlab::Email::SmtpConfig.encrypted_secrets.active? },
      operating_system: alt_usage_data(fallback: nil) { operating_system },
      gitaly_apdex: alt_usage_data { gitaly_apdex },
      collected_data_categories: add_metric('CollectedDataCategoriesMetric', time_frame: 'none'),
      service_ping_features_enabled: add_metric('ServicePingFeaturesMetric', time_frame: 'none'),
      snowplow_enabled: add_metric('SnowplowEnabledMetric', time_frame: 'none'),
      snowplow_configured_to_gitlab_collector: add_metric('SnowplowConfiguredToGitlabCollectorMetric', time_frame: 'none'),
      certificate_based_clusters_ff: add_metric('CertBasedClustersFfMetric')
    }
  }
end

.system_usage_data_weeklyObject


226
227
228
229
230
# File 'lib/gitlab/usage_data.rb', line 226

def system_usage_data_weekly
  {
    counts_weekly: {}
  }
end

.topology_usage_dataObject


339
340
341
# File 'lib/gitlab/usage_data.rb', line 339

def topology_usage_data
  Gitlab::UsageData::Topology.new.topology_usage_data
end

.usage_activity_by_stage(key = :usage_activity_by_stage, time_period = {}) ⇒ Object


466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
# File 'lib/gitlab/usage_data.rb', line 466

def usage_activity_by_stage(key = :usage_activity_by_stage, time_period = {})
  {
    key => {
      configure: usage_activity_by_stage_configure(time_period),
      create: usage_activity_by_stage_create(time_period),
      enablement: usage_activity_by_stage_enablement(time_period),
      manage: usage_activity_by_stage_manage(time_period),
      monitor: usage_activity_by_stage_monitor(time_period),
      package: usage_activity_by_stage_package(time_period),
      plan: usage_activity_by_stage_plan(time_period),
      release: usage_activity_by_stage_release(time_period),
      secure: usage_activity_by_stage_secure(time_period),
      verify: usage_activity_by_stage_verify(time_period)
    }
  }
end

.usage_activity_by_stage_configure(time_period) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord rubocop: disable UsageData/LargeTable


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'lib/gitlab/usage_data.rb', line 485

def usage_activity_by_stage_configure(time_period)
  {
    clusters_management_project: clusters_user_distinct_count(::Clusters::Cluster.with_management_project, time_period),
    clusters_disabled: clusters_user_distinct_count(::Clusters::Cluster.disabled, time_period),
    clusters_enabled: clusters_user_distinct_count(::Clusters::Cluster.enabled, time_period),
    clusters_platforms_gke: clusters_user_distinct_count(::Clusters::Cluster.gcp_installed.enabled, time_period),
    clusters_platforms_eks: clusters_user_distinct_count(::Clusters::Cluster.aws_installed.enabled, time_period),
    clusters_platforms_user: clusters_user_distinct_count(::Clusters::Cluster.user_provided.enabled, time_period),
    instance_clusters_disabled: clusters_user_distinct_count(::Clusters::Cluster.disabled.instance_type, time_period),
    instance_clusters_enabled: clusters_user_distinct_count(::Clusters::Cluster.enabled.instance_type, time_period),
    group_clusters_disabled: clusters_user_distinct_count(::Clusters::Cluster.disabled.group_type, time_period),
    group_clusters_enabled: clusters_user_distinct_count(::Clusters::Cluster.enabled.group_type, time_period),
    project_clusters_disabled: clusters_user_distinct_count(::Clusters::Cluster.disabled.project_type, time_period),
    project_clusters_enabled: clusters_user_distinct_count(::Clusters::Cluster.enabled.project_type, time_period)
  }
end

.usage_activity_by_stage_create(time_period) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord


505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'lib/gitlab/usage_data.rb', line 505

def usage_activity_by_stage_create(time_period)
  {
    deploy_keys: distinct_count(::DeployKey.where(time_period), :user_id),
    keys: distinct_count(::Key.regular_keys.where(time_period), :user_id),
    projects_with_disable_overriding_approvers_per_merge_request: count(::Project.where(time_period.merge(disable_overriding_approvers_per_merge_request: true))),
    projects_without_disable_overriding_approvers_per_merge_request: count(::Project.where(time_period.merge(disable_overriding_approvers_per_merge_request: [false, nil]))),
    remote_mirrors: distinct_count(::Project.with_remote_mirrors.where(time_period), :creator_id),
    snippets: distinct_count(::Snippet.where(time_period), :author_id)
  }.tap do |h|
    if time_period.present?
      h[:merge_requests_users] = merge_requests_users(time_period)
      h.merge!(action_monthly_active_users(time_period))
    end
  end
end

.usage_activity_by_stage_enablement(time_period) ⇒ Object

Empty placeholder allows this to match the pattern used by other sections


523
524
525
# File 'lib/gitlab/usage_data.rb', line 523

def usage_activity_by_stage_enablement(time_period)
  {}
end

.usage_activity_by_stage_manage(time_period) ⇒ Object

Omitted because no user, creator or author associated: `campaigns_imported_from_github`, `ldap_group_links` rubocop: disable CodeReuse/ActiveRecord


529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
# File 'lib/gitlab/usage_data.rb', line 529

def usage_activity_by_stage_manage(time_period)
  {
    # rubocop: disable UsageData/LargeTable
    events: stage_manage_events(time_period),
    groups: distinct_count(::GroupMember.where(time_period), :user_id),
    users_created: count(::User.where(time_period), start: minimum_id(User), finish: maximum_id(User)),
    omniauth_providers: filtered_omniauth_provider_names.reject { |name| name == 'group_saml' },
    user_auth_by_provider: distinct_count_user_auth_by_provider(time_period),
    unique_users_all_imports: unique_users_all_imports(time_period),
    bulk_imports: {
      gitlab_v1: count(::BulkImport.where(**time_period, source_type: :gitlab))
    },
    project_imports: project_imports(time_period),
    issue_imports: issue_imports(time_period),
    group_imports: group_imports(time_period)
  }
end

.usage_activity_by_stage_monitor(time_period) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord


549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
# File 'lib/gitlab/usage_data.rb', line 549

def usage_activity_by_stage_monitor(time_period)
  # Calculate histogram only for overall as other time periods aren't available/useful here.
  integrations_histogram = time_period.empty? ? histogram(::AlertManagement::HttpIntegration.active, :project_id, buckets: 1..100) : nil

  {
    clusters: distinct_count(::Clusters::Cluster.where(time_period), :user_id),
    clusters_integrations_prometheus: cluster_integrations_user_distinct_count(::Clusters::Integrations::Prometheus, time_period),
    operations_dashboard_default_dashboard: count(::User.active.with_dashboard('operations').where(time_period),
                                                  start: minimum_id(User),
                                                  finish: maximum_id(User)),
    projects_with_error_tracking_enabled: distinct_count(::Project.with_enabled_error_tracking.where(time_period), :creator_id),
    projects_with_incidents: distinct_count(::Issue.incident.where(time_period), :project_id),
    projects_with_alert_incidents: distinct_count(::Issue.incident.with_alert_management_alerts.where(time_period), :project_id),
    projects_with_enabled_alert_integrations_histogram: integrations_histogram
  }.compact
end

.usage_activity_by_stage_package(time_period) ⇒ Object

rubocop: disable CodeReuse/ActiveRecord


568
569
570
571
572
# File 'lib/gitlab/usage_data.rb', line 568

def usage_activity_by_stage_package(time_period)
  {
    projects_with_packages: distinct_count(::Project.with_packages.where(time_period), :creator_id)
  }
end

.usage_activity_by_stage_plan(time_period) ⇒ Object

Omitted because no user, creator or author associated: `boards`, `labels`, `milestones`, `uploads` Omitted because too expensive: `epics_deepest_relationship_level` Omitted because of encrypted properties: `projects_jira_cloud_active`, `projects_jira_server_active` rubocop: disable CodeReuse/ActiveRecord


579
580
581
582
583
584
585
586
587
588
589
590
591
592
# File 'lib/gitlab/usage_data.rb', line 579

def usage_activity_by_stage_plan(time_period)
  time_frame = metric_time_period(time_period)
  {
    issues: add_metric('CountUsersCreatingIssuesMetric', time_frame: time_frame),
    notes: distinct_count(::Note.where(time_period), :author_id),
    projects: distinct_count(::Project.where(time_period), :creator_id),
    todos: distinct_count(::Todo.where(time_period), :author_id),
    service_desk_enabled_projects: distinct_count_service_desk_enabled_projects(time_period),
    service_desk_issues: count(::Issue.service_desk.where(time_period)),
    projects_jira_active: distinct_count(::Project.with_active_integration(::Integrations::Jira).where(time_period), :creator_id),
    projects_jira_dvcs_cloud_active: distinct_count(::Project.with_active_integration(::Integrations::Jira).with_jira_dvcs_cloud.where(time_period), :creator_id),
    projects_jira_dvcs_server_active: distinct_count(::Project.with_active_integration(::Integrations::Jira).with_jira_dvcs_server.where(time_period), :creator_id)
  }
end

.usage_activity_by_stage_release(time_period) ⇒ Object

Omitted because no user, creator or author associated: `environments`, `feature_flags`, `in_review_folder`, `pages_domains` rubocop: disable CodeReuse/ActiveRecord


597
598
599
600
601
602
603
604
605
606
# File 'lib/gitlab/usage_data.rb', line 597

def usage_activity_by_stage_release(time_period)
  time_frame = metric_time_period(time_period)
  {
    deployments: distinct_count(::Deployment.where(time_period), :user_id),
    failed_deployments: distinct_count(::Deployment.failed.where(time_period), :user_id),
    releases: distinct_count(::Release.where(time_period), :author_id),
    successful_deployments: distinct_count(::Deployment.success.where(time_period), :user_id),
    releases_with_milestones: add_metric('CountUsersAssociatingMilestonesToReleasesMetric', time_frame: time_frame)
  }
end

.usage_activity_by_stage_secure(time_period) ⇒ Object

Currently too complicated and to get reliable counts for these stats: container_scanning_jobs, dast_jobs, dependency_scanning_jobs, license_management_jobs, sast_jobs, secret_detection_jobs Once gitlab.com/gitlab-org/gitlab/merge_requests/17568 is merged, this might be doable


628
629
630
# File 'lib/gitlab/usage_data.rb', line 628

def usage_activity_by_stage_secure(time_period)
  {}
end

.usage_activity_by_stage_verify(time_period) ⇒ Object

Omitted because no user, creator or author associated: `ci_runners` rubocop: disable CodeReuse/ActiveRecord


611
612
613
614
615
616
617
618
619
620
621
622
# File 'lib/gitlab/usage_data.rb', line 611

def usage_activity_by_stage_verify(time_period)
  {
    ci_builds: distinct_count(::Ci::Build.where(time_period), :user_id),
    ci_external_pipelines: distinct_count(::Ci::Pipeline.external.where(time_period), :user_id, start: minimum_id(User), finish: maximum_id(User)),
    ci_internal_pipelines: distinct_count(::Ci::Pipeline.internal.where(time_period), :user_id, start: minimum_id(User), finish: maximum_id(User)),
    ci_pipeline_config_auto_devops: distinct_count(::Ci::Pipeline.auto_devops_source.where(time_period), :user_id, start: minimum_id(User), finish: maximum_id(User)),
    ci_pipeline_config_repository: distinct_count(::Ci::Pipeline.repository_source.where(time_period), :user_id, start: minimum_id(User), finish: maximum_id(User)),
    ci_pipeline_schedules: distinct_count(::Ci::PipelineSchedule.where(time_period), :owner_id),
    ci_pipelines: distinct_count(::Ci::Pipeline.where(time_period), :user_id, start: minimum_id(User), finish: maximum_id(User)),
    ci_triggers: distinct_count(::Ci::Trigger.where(time_period), :owner_id)
  }
end

.usage_countersHash<Symbol, Integer>

Returns:

  • (Hash<Symbol, Integer>)

265
266
267
# File 'lib/gitlab/usage_data.rb', line 265

def usage_counters
  usage_data_counters.map { |counter| redis_usage_data(counter) }.reduce({}, :merge)
end

.usage_data_countersArray<#totals>

Returns An array of objects that respond to `#totals`.

Returns:

  • (Array<#totals>)

    An array of objects that respond to `#totals`


270
271
272
# File 'lib/gitlab/usage_data.rb', line 270

def usage_data_counters
  Gitlab::UsageDataCounters.counters
end

.user_preferences_usageObject

augmented in EE


428
429
430
431
432
# File 'lib/gitlab/usage_data.rb', line 428

def user_preferences_usage
  {
    user_preferences_user_gitpod_enabled: count(UserPreference.with_user.gitpod_enabled.merge(User.active))
  }
end

.with_durationObject


653
654
655
656
657
658
659
660
661
662
# File 'lib/gitlab/usage_data.rb', line 653

def with_duration
  return yield unless Feature.enabled?(:measure_service_ping_metric_collection)

  result = nil
  duration = Benchmark.realtime do
    result = yield
  end

  ::Gitlab::Usage::ServicePing::LegacyMetricTimingDecorator.new(result, duration)
end