debian-mirror-gitlab/lib/gitlab/usage_data.rb

449 lines
19 KiB
Ruby
Raw Normal View History

2018-12-13 13:39:08 +05:30
# frozen_string_literal: true
2020-05-24 23:13:21 +05:30
# For hardening usage ping and make it easier to add measures there is in place
# * alt_usage_data method
# handles StandardError and fallbacks into -1 this way not all measures fail if we encounter one exception
2020-04-22 19:07:51 +05:30
#
2020-05-24 23:13:21 +05:30
# Examples:
# alt_usage_data { Gitlab::VERSION }
# alt_usage_data { Gitlab::CurrentSettings.uuid }
#
# * redis_usage_data method
# handles ::Redis::CommandError, Gitlab::UsageDataCounters::BaseCounter::UnknownEvent
# returns -1 when a block is sent or hash with all values -1 when a counter is sent
# different behaviour due to 2 different implementations of redis counter
#
# Examples:
# redis_usage_data(Gitlab::UsageDataCounters::WikiPageCounter)
# redis_usage_data { ::Gitlab::UsageCounters::PodLogs.usage_totals[:total] }
2017-08-17 22:00:37 +05:30
module Gitlab
class UsageData
2019-12-04 20:38:33 +05:30
BATCH_SIZE = 100
2020-05-24 23:13:21 +05:30
FALLBACK = -1
2019-02-15 15:39:39 +05:30
2017-08-17 22:00:37 +05:30
class << self
def data(force_refresh: false)
2019-10-12 21:52:04 +05:30
Rails.cache.fetch('usage_data', force: force_refresh, expires_in: 2.weeks) do
uncached_data
end
2017-08-17 22:00:37 +05:30
end
def uncached_data
2019-12-26 22:10:19 +05:30
license_usage_data
.merge(system_usage_data)
2019-12-04 20:38:33 +05:30
.merge(features_usage_data)
.merge(components_usage_data)
.merge(cycle_analytics_usage_data)
2020-05-24 23:13:21 +05:30
.merge(object_store_usage_data)
.merge(recording_ce_finish_data)
2017-08-17 22:00:37 +05:30
end
def to_json(force_refresh: false)
data(force_refresh: force_refresh).to_json
end
2018-03-17 18:26:18 +05:30
def license_usage_data
2020-04-22 19:07:51 +05:30
{
2020-05-24 23:13:21 +05:30
recorded_at: Time.now, # should be calculated very first
2020-04-22 19:07:51 +05:30
uuid: alt_usage_data { Gitlab::CurrentSettings.uuid },
hostname: alt_usage_data { Gitlab.config.gitlab.host },
version: alt_usage_data { Gitlab::VERSION },
installation_type: alt_usage_data { installation_type },
2018-11-20 20:47:30 +05:30
active_user_count: count(User.active),
2018-03-17 18:26:18 +05:30
edition: 'CE'
}
end
2020-05-24 23:13:21 +05:30
def recording_ce_finish_data
{
recording_ce_finished_at: Time.now
}
end
2019-12-21 20:55:43 +05:30
# rubocop: disable Metrics/AbcSize
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-08-17 22:00:37 +05:30
def system_usage_data
2020-05-24 23:13:21 +05:30
alert_bot_incident_count = count(::Issue.authored(::User.alert_bot))
2017-08-17 22:00:37 +05:30
{
counts: {
2018-11-20 20:47:30 +05:30
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),
2019-07-07 11:18:12 +05:30
successful_deployments: count(Deployment.success),
failed_deployments: count(Deployment.failed),
2018-11-20 20:47:30 +05:30
environments: count(::Environment),
clusters: count(::Clusters::Cluster),
clusters_enabled: count(::Clusters::Cluster.enabled),
2019-02-15 15:39:39 +05:30
project_clusters_enabled: count(::Clusters::Cluster.enabled.project_type),
group_clusters_enabled: count(::Clusters::Cluster.enabled.group_type),
2020-04-22 19:07:51 +05:30
instance_clusters_enabled: count(::Clusters::Cluster.enabled.instance_type),
2018-11-20 20:47:30 +05:30
clusters_disabled: count(::Clusters::Cluster.disabled),
2019-02-15 15:39:39 +05:30
project_clusters_disabled: count(::Clusters::Cluster.disabled.project_type),
group_clusters_disabled: count(::Clusters::Cluster.disabled.group_type),
2020-04-22 19:07:51 +05:30
instance_clusters_disabled: count(::Clusters::Cluster.disabled.instance_type),
2020-04-08 14:13:33 +05:30
clusters_platforms_eks: count(::Clusters::Cluster.aws_installed.enabled),
clusters_platforms_gke: count(::Clusters::Cluster.gcp_installed.enabled),
2018-11-20 20:47:30 +05:30
clusters_platforms_user: count(::Clusters::Cluster.user_provided.enabled),
2019-07-07 11:18:12 +05:30
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),
2019-12-26 22:10:19 +05:30
clusters_applications_crossplane: count(::Clusters::Applications::Crossplane.available),
2019-07-07 11:18:12 +05:30
clusters_applications_prometheus: count(::Clusters::Applications::Prometheus.available),
clusters_applications_runner: count(::Clusters::Applications::Runner.available),
clusters_applications_knative: count(::Clusters::Applications::Knative.available),
2019-12-26 22:10:19 +05:30
clusters_applications_elastic_stack: count(::Clusters::Applications::ElasticStack.available),
2020-03-13 15:44:24 +05:30
clusters_applications_jupyter: count(::Clusters::Applications::Jupyter.available),
2020-04-22 19:07:51 +05:30
clusters_management_project: count(::Clusters::Cluster.with_management_project),
2018-11-20 20:47:30 +05:30
in_review_folder: count(::Environment.in_review_folder),
2019-12-26 22:10:19 +05:30
grafana_integrated_projects: count(GrafanaIntegration.enabled),
2018-11-20 20:47:30 +05:30
groups: count(Group),
issues: count(Issue),
2020-01-01 13:55:28 +05:30
issues_created_from_gitlab_error_tracking_ui: count(SentryIssue),
2019-12-26 22:10:19 +05:30
issues_with_associated_zoom_link: count(ZoomMeeting.added_to_issue),
2020-04-08 14:13:33 +05:30
issues_using_zoom_quick_actions: distinct_count(ZoomMeeting, :issue_id),
2020-04-22 19:07:51 +05:30
issues_with_embedded_grafana_charts_approx: grafana_embed_usage_data,
2020-05-24 23:13:21 +05:30
issues_created_gitlab_alerts: count(Issue.with_alert_management_alerts.not_authored_by(::User.alert_bot)),
incident_issues: alert_bot_incident_count,
alert_bot_incident_issues: alert_bot_incident_count,
incident_labeled_issues: count(::Issue.with_label_attributes(IncidentManagement::CreateIssueService::INCIDENT_LABEL)),
2018-11-20 20:47:30 +05:30
keys: count(Key),
label_lists: count(List.label),
lfs_objects: count(LfsObject),
milestone_lists: count(List.milestone),
milestones: count(Milestone),
pages_domains: count(PagesDomain),
2019-09-04 21:01:54 +05:30
pool_repositories: count(PoolRepository),
2018-11-20 20:47:30 +05:30
projects: count(Project),
projects_imported_from_github: count(Project.where(import_type: 'github')),
2019-03-02 22:35:43 +05:30
projects_with_repositories_enabled: count(ProjectFeature.where('repository_access_level > ?', ProjectFeature::DISABLED)),
2019-07-07 11:18:12 +05:30
projects_with_error_tracking_enabled: count(::ErrorTracking::ProjectErrorTrackingSetting.where(enabled: true)),
2020-04-22 19:07:51 +05:30
projects_with_alerts_service_enabled: count(AlertsService.active),
projects_with_prometheus_alerts: distinct_count(PrometheusAlert, :project_id),
2018-11-20 20:47:30 +05:30
protected_branches: count(ProtectedBranch),
releases: count(Release),
remote_mirrors: count(RemoteMirror),
snippets: count(Snippet),
2019-02-15 15:39:39 +05:30
suggestions: count(Suggestion),
2018-11-20 20:47:30 +05:30
todos: count(Todo),
uploads: count(Upload),
2020-04-08 14:13:33 +05:30
web_hooks: count(WebHook),
labels: count(Label),
merge_requests: count(MergeRequest),
notes: count(Note)
2019-12-21 20:55:43 +05:30
}.merge(
services_usage,
usage_counters,
2020-01-01 13:55:28 +05:30
user_preferences_usage,
2020-05-24 23:13:21 +05:30
ingress_modsecurity_usage,
container_expiration_policies_usage
2019-12-21 20:55:43 +05:30
)
}
2017-08-17 22:00:37 +05:30
end
2018-12-05 23:21:45 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2019-12-21 20:55:43 +05:30
# rubocop: enable Metrics/AbcSize
2017-08-17 22:00:37 +05:30
2018-03-27 19:54:05 +05:30
def cycle_analytics_usage_data
Gitlab::CycleAnalytics::UsageData.new.to_json
2020-04-08 14:13:33 +05:30
rescue ActiveRecord::StatementInvalid
{ avg_cycle_analytics: {} }
2018-03-27 19:54:05 +05:30
end
2020-04-22 19:07:51 +05:30
# rubocop:disable CodeReuse/ActiveRecord
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
# rubocop: enable CodeReuse/ActiveRecord
2018-03-17 18:26:18 +05:30
def features_usage_data
features_usage_data_ce
end
def features_usage_data_ce
{
2020-04-22 19:07:51 +05:30
container_registry_enabled: alt_usage_data { Gitlab.config.registry.enabled },
2019-12-21 20:55:43 +05:30
dependency_proxy_enabled: Gitlab.config.try(:dependency_proxy)&.enabled,
2020-04-22 19:07:51 +05:30
gitlab_shared_runners_enabled: alt_usage_data { Gitlab.config.gitlab_ci.shared_runners_enabled },
gravatar_enabled: alt_usage_data { Gitlab::CurrentSettings.gravatar_enabled? },
ldap_enabled: alt_usage_data { Gitlab.config.ldap.enabled },
mattermost_enabled: alt_usage_data { Gitlab.config.mattermost.enabled },
omniauth_enabled: alt_usage_data { Gitlab::Auth.omniauth_enabled? },
prometheus_metrics_enabled: alt_usage_data { Gitlab::Metrics.prometheus_metrics_enabled? },
reply_by_email_enabled: alt_usage_data { Gitlab::IncomingEmail.enabled? },
signup_enabled: alt_usage_data { Gitlab::CurrentSettings.allow_signup? },
web_ide_clientside_preview_enabled: alt_usage_data { Gitlab::CurrentSettings.web_ide_clientside_preview_enabled? },
2020-05-24 23:13:21 +05:30
ingress_modsecurity_enabled: Feature.enabled?(:ingress_modsecurity),
grafana_link_enabled: alt_usage_data { Gitlab::CurrentSettings.grafana_enabled? }
}
2020-04-22 19:07:51 +05:30
end
2019-10-12 21:52:04 +05:30
# @return [Hash<Symbol, Integer>]
2018-12-05 23:21:45 +05:30
def usage_counters
2020-05-24 23:13:21 +05:30
usage_data_counters.map { |counter| redis_usage_data(counter) }.reduce({}, :merge)
2019-10-12 21:52:04 +05:30
end
# @return [Array<#totals>] An array of objects that respond to `#totals`
def usage_data_counters
[
2019-12-21 20:55:43 +05:30
Gitlab::UsageDataCounters::WikiPageCounter,
Gitlab::UsageDataCounters::WebIdeCounter,
Gitlab::UsageDataCounters::NoteCounter,
Gitlab::UsageDataCounters::SnippetCounter,
Gitlab::UsageDataCounters::SearchCounter,
Gitlab::UsageDataCounters::CycleAnalyticsCounter,
Gitlab::UsageDataCounters::ProductivityAnalyticsCounter,
Gitlab::UsageDataCounters::SourceCodeCounter,
2020-05-24 23:13:21 +05:30
Gitlab::UsageDataCounters::MergeRequestCounter,
Gitlab::UsageDataCounters::DesignsCounter
2019-10-12 21:52:04 +05:30
]
2018-12-05 23:21:45 +05:30
end
2018-03-17 18:26:18 +05:30
def components_usage_data
{
2020-04-22 19:07:51 +05:30
git: { version: alt_usage_data { Gitlab::Git.version } },
gitaly: {
version: alt_usage_data { Gitaly::Server.all.first.server_version },
servers: alt_usage_data { Gitaly::Server.count },
filesystems: alt_usage_data { Gitaly::Server.filesystems }
},
gitlab_pages: {
enabled: alt_usage_data { Gitlab.config.pages.enabled },
version: alt_usage_data { Gitlab::Pages::VERSION }
},
database: {
adapter: alt_usage_data { Gitlab::Database.adapter_name },
version: alt_usage_data { Gitlab::Database.version }
},
app_server: { type: app_server_type }
2018-03-17 18:26:18 +05:30
}
2017-08-17 22:00:37 +05:30
end
2017-09-10 17:25:29 +05:30
2020-04-22 19:07:51 +05:30
def app_server_type
Gitlab::Runtime.identify.to_s
rescue Gitlab::Runtime::IdentificationError => e
Gitlab::AppLogger.error(e.message)
Gitlab::ErrorTracking.track_exception(e)
'unknown_app_server_type'
end
2020-05-24 23:13:21 +05:30
def object_store_config(component)
config = alt_usage_data(fallback: nil) do
Settings[component]['object_store']
end
if config
{
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
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
2020-01-01 13:55:28 +05:30
def ingress_modsecurity_usage
2020-05-24 23:13:21 +05:30
##
# This method measures usage of the Modsecurity Web Application Firewall across the entire
# instance's deployed environments.
#
# NOTE: this service is an approximation as it does not yet take into account if environment
# is enabled and only measures applications installed using GitLab Managed Apps (disregards
# CI-based managed apps).
#
# More details: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28331#note_318621786
##
column = ::Deployment.arel_table[:environment_id]
{
ingress_modsecurity_logging: distinct_count(successful_deployments_with_cluster(::Clusters::Applications::Ingress.modsecurity_enabled.logging), column),
ingress_modsecurity_blocking: distinct_count(successful_deployments_with_cluster(::Clusters::Applications::Ingress.modsecurity_enabled.blocking), column),
ingress_modsecurity_disabled: distinct_count(successful_deployments_with_cluster(::Clusters::Applications::Ingress.modsecurity_disabled), column),
ingress_modsecurity_not_installed: distinct_count(successful_deployments_with_cluster(::Clusters::Applications::Ingress.modsecurity_not_installed), column)
}
end
# rubocop: disable CodeReuse/ActiveRecord
def container_expiration_policies_usage
results = {}
start = ::Project.minimum(:id)
finish = ::Project.maximum(:id)
results[:projects_with_expiration_policy_disabled] = distinct_count(::ContainerExpirationPolicy.where(enabled: false), :project_id, start: start, finish: finish)
base = ::ContainerExpirationPolicy.active
results[:projects_with_expiration_policy_enabled] = distinct_count(base, :project_id, start: start, finish: finish)
%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
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
2020-01-01 13:55:28 +05:30
end
2020-05-24 23:13:21 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2020-01-01 13:55:28 +05:30
2018-12-05 23:21:45 +05:30
# rubocop: disable CodeReuse/ActiveRecord
2017-09-10 17:25:29 +05:30
def services_usage
2020-04-08 14:13:33 +05:30
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))
2020-03-13 15:44:24 +05:30
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]
2017-09-10 17:25:29 +05:30
2020-05-24 23:13:21 +05:30
results.merge(jira_usage).merge(jira_import_usage)
2018-12-13 13:39:08 +05:30
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
2019-12-04 20:38:33 +05:30
results = {
projects_jira_server_active: 0,
projects_jira_cloud_active: 0,
2020-04-22 19:07:51 +05:30
projects_jira_active: 0
2018-12-13 13:39:08 +05:30
}
2019-12-04 20:38:33 +05:30
2019-12-26 22:10:19 +05:30
Service.active
.by_type(:JiraService)
2019-12-04 20:38:33 +05:30
.includes(:jira_tracker_data)
.find_in_batches(batch_size: BATCH_SIZE) do |services|
counts = services.group_by do |service|
2019-12-21 20:55:43 +05:30
# TODO: Simplify as part of https://gitlab.com/gitlab-org/gitlab/issues/29404
2019-12-04 20:38:33 +05:30
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]
2020-04-22 19:07:51 +05:30
results[:projects_jira_active] += services.size
2019-12-04 20:38:33 +05:30
end
results
2020-04-22 19:07:51 +05:30
rescue ActiveRecord::StatementInvalid
2020-05-24 23:13:21 +05:30
{ projects_jira_server_active: FALLBACK, projects_jira_cloud_active: FALLBACK, projects_jira_active: FALLBACK }
end
def successful_deployments_with_cluster(scope)
scope
.joins(cluster: :deployments)
.merge(Clusters::Cluster.enabled)
.merge(Deployment.success)
2018-11-20 20:47:30 +05:30
end
2020-03-13 15:44:24 +05:30
# rubocop: enable CodeReuse/ActiveRecord
2018-11-20 20:47:30 +05:30
2020-05-24 23:13:21 +05:30
def jira_import_usage
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: alt_usage_data { JiraImportState.finished_imports_count }
}
end
2019-03-02 22:35:43 +05:30
def user_preferences_usage
{} # augmented in EE
end
2020-05-24 23:13:21 +05:30
def count(relation, column = nil, batch: true, start: nil, finish: nil)
2020-04-08 14:13:33 +05:30
if batch && Feature.enabled?(:usage_ping_batch_counter, default_enabled: true)
2020-04-22 19:07:51 +05:30
Gitlab::Database::BatchCount.batch_count(relation, column, start: start, finish: finish)
2020-03-13 15:44:24 +05:30
else
relation.count
end
rescue ActiveRecord::StatementInvalid
2020-05-24 23:13:21 +05:30
FALLBACK
2020-03-13 15:44:24 +05:30
end
2020-05-24 23:13:21 +05:30
def distinct_count(relation, column = nil, batch: true, start: nil, finish: nil)
2020-04-08 14:13:33 +05:30
if batch && Feature.enabled?(:usage_ping_batch_counter, default_enabled: true)
2020-04-22 19:07:51 +05:30
Gitlab::Database::BatchCount.batch_distinct_count(relation, column, start: start, finish: finish)
2020-03-13 15:44:24 +05:30
else
relation.distinct_count_by(column)
end
2018-11-20 20:47:30 +05:30
rescue ActiveRecord::StatementInvalid
2020-05-24 23:13:21 +05:30
FALLBACK
2017-09-10 17:25:29 +05:30
end
2019-02-15 15:39:39 +05:30
2020-05-24 23:13:21 +05:30
def alt_usage_data(value = nil, fallback: FALLBACK, &block)
2020-04-22 19:07:51 +05:30
if block_given?
yield
else
value
end
rescue
fallback
end
2020-05-24 23:13:21 +05:30
def redis_usage_data(counter = nil, &block)
if block_given?
redis_usage_counter(&block)
elsif counter.present?
redis_usage_data_totals(counter)
end
end
2020-04-22 19:07:51 +05:30
private
2020-05-24 23:13:21 +05:30
def redis_usage_counter
yield
rescue ::Redis::CommandError, Gitlab::UsageDataCounters::BaseCounter::UnknownEvent
FALLBACK
end
def redis_usage_data_totals(counter)
counter.totals
rescue ::Redis::CommandError, Gitlab::UsageDataCounters::BaseCounter::UnknownEvent
counter.fallback_totals
end
2019-09-04 21:01:54 +05:30
def installation_type
if Rails.env.production?
Gitlab::INSTALLATION_TYPE
else
"gitlab-development-kit"
end
end
2017-08-17 22:00:37 +05:30
end
end
end
2019-12-04 20:38:33 +05:30
Gitlab::UsageData.prepend_if_ee('EE::Gitlab::UsageData')