Skip to content

G
gitlab-ce
Commit 7536c6ff authored by Sid Reddy's avatar Sid Reddy Committed by Suzanne Selhorn
Browse files
Options

Usage Statistics Definitions

parent 770fd9e1
Hide whitespace changes
Inline Side-by-side
Showing with 262 additions and 6 deletions
doc/development/telemetry/usage_ping.md
View file @ 7536c6ff
...@@ -136,12 +136,12 @@ For large tables, PostgreSQL can take a long time to count rows due to MVCC [(Mu ...@@ -136,12 +136,12 @@ For large tables, PostgreSQL can take a long time to count rows due to MVCC [(Mu
For GitLab.com, there are extremely large tables with 15 second query timeouts, so we use batch counting to avoid encountering timeouts. Here are the sizes of some GitLab.com tables: For GitLab.com, there are extremely large tables with 15 second query timeouts, so we use batch counting to avoid encountering timeouts. Here are the sizes of some GitLab.com tables:
| Table | Row counts in millions | | Table | Row counts in millions |
| ------ | ------ | |----------------------------|------------------------|
| merge_request_diff_commits | 2280 | | merge_request_diff_commits | 2280 |
| ci_build_trace_sections | 1764 | | ci_build_trace_sections | 1764 |
| merge_request_diff_files | 1082 | | merge_request_diff_files | 1082 |
| events | 514 | | events | 514 |
There are two batch counting methods provided, `Ordinary Batch Counters` and `Distinct Batch Counters`. Batch counting requires indexes on columns to calculate max, min, and range queries. In some cases, a specialized index may need to be added on the columns involved in a counter. There are two batch counting methods provided, `Ordinary Batch Counters` and `Distinct Batch Counters`. Batch counting requires indexes on columns to calculate max, min, and range queries. In some cases, a specialized index may need to be added on the columns involved in a counter.
...@@ -293,6 +293,262 @@ Examples of query optimization work: ...@@ -293,6 +293,262 @@ Examples of query optimization work:
On GitLab.com, we have DangerBot setup to monitor Telemetry related files and DangerBot will recommend a Telemetry review. Mention `@gitlab-org/growth/telemetry/engineers` in your MR for a review. On GitLab.com, we have DangerBot setup to monitor Telemetry related files and DangerBot will recommend a Telemetry review. Mention `@gitlab-org/growth/telemetry/engineers` in your MR for a review.
## Usage Statistics definitions
| Statistic | Section | Stage | Description |
|:--------------------------------------------------------|:-----------------------------------|:------------|:--------------------------------------------------|
| `uuid` | | | |
| `hostname` | | | |
| `version` | | | |
| `installation_type` | | | |
| `active_user_count` | | | |
| `recorded_at` | | | |
| `edition` | | | |
| `license_md5` | | | |
| `license_id` | | | |
| `historical_max_users` | | | |
| `Name` | `licensee` | | |
| `Email` | `licensee` | | |
| `Company` | `licensee` | | |
| `license_user_count` | | | |
| `license_starts_at` | | | |
| `license_expires_at` | | | |
| `license_plan` | | | |
| `license_trial` | | | |
| `assignee_lists` | `counts` | | |
| `boards` | `counts` | | |
| `ci_builds` | `counts` | | |
| `ci_internal_pipelines` | `counts` | | |
| `ci_external_pipelines` | `counts` | | |
| `ci_pipeline_config_auto_devops` | `counts` | | |
| `ci_pipeline_config_repository` | `counts` | | |
| `ci_runners` | `counts` | | |
| `ci_triggers` | `counts` | | |
| `ci_pipeline_schedules` | `counts` | | |
| `auto_devops_enabled` | `counts` | | |
| `auto_devops_disabled` | `counts` | | |
| `deploy_keys` | `counts` | | |
| `deployments` | `counts` | | |
| `dast_jobs` | `counts` | | |
| `successful_deployments` | `counts` | | |
| `failed_deployments` | `counts` | | |
| `environments` | `counts` | | |
| `clusters` | `counts` | | |
| `clusters_enabled` | `counts` | | |
| `project_clusters_enabled` | `counts` | | |
| `group_clusters_enabled` | `counts` | | |
| `instance_clusters_enabled` | `counts` | | |
| `clusters_disabled` | `counts` | | |
| `project_clusters_disabled` | `counts` | | |
| `group_clusters_disabled` | `counts` | | |
| `instance_clusters_disabled` | `counts` | | |
| `clusters_platforms_eks` | `counts` | | |
| `clusters_platforms_gke` | `counts` | | |
| `clusters_platforms_user` | `counts` | | |
| `clusters_applications_helm` | `counts` | | |
| `clusters_applications_ingress` | `counts` | | |
| `clusters_applications_cert_managers` | `counts` | | |
| `clusters_applications_crossplane` | `counts` | | |
| `clusters_applications_prometheus` | `counts` | | |
| `clusters_applications_runner` | `counts` | | |
| `clusters_applications_knative` | `counts` | | |
| `clusters_applications_elastic_stack` | `counts` | | |
| `clusters_management_project` | `counts` | | |
| `in_review_folder` | `counts` | | |
| `grafana_integrated_projects` | `counts` | | |
| `groups` | `counts` | | |
| `issues` | `counts` | | |
| `issues_created_from_gitlab_error_tracking_ui` | `counts` | | |
| `issues_with_associated_zoom_link` | `counts` | | |
| `issues_using_zoom_quick_actions` | `counts` | | |
| `issues_with_embedded_grafana_charts_approx` | `counts` | | |
| `issues_with_health_status` | `counts` | | |
| `keys` | `counts` | | |
| `label_lists` | `counts` | | |
| `lfs_objects` | `counts` | | |
| `milestone_lists` | `counts` | | |
| `milestones` | `counts` | | |
| `pages_domains` | `counts` | | |
| `pool_repositories` | `counts` | | |
| `projects` | `counts` | | |
| `projects_imported_from_github` | `counts` | | |
| `projects_with_repositories_enabled` | `counts` | | |
| `projects_with_error_tracking_enabled` | `counts` | | |
| `protected_branches` | `counts` | | |
| `releases` | `counts` | | |
| `remote_mirrors` | `counts` | | |
| `requirements_created` | `counts` | | |
| `snippets` | `counts` | | |
| `suggestions` | `counts` | | |
| `todos` | `counts` | | |
| `uploads` | `counts` | | |
| `web_hooks` | `counts` | | |
| `projects_alerts_active` | `counts` | | |
| `projects_asana_active` | `counts` | | |
| `projects_assembla_active` | `counts` | | |
| `projects_bamboo_active` | `counts` | | |
| `projects_bugzilla_active` | `counts` | | |
| `projects_buildkite_active` | `counts` | | |
| `projects_campfire_active` | `counts` | | |
| `projects_custom_issue_tracker_active` | `counts` | | |
| `projects_discord_active` | `counts` | | |
| `projects_drone_ci_active` | `counts` | | |
| `projects_emails_on_push_active` | `counts` | | |
| `projects_external_wiki_active` | `counts` | | |
| `projects_flowdock_active` | `counts` | | |
| `projects_github_active` | `counts` | | |
| `projects_hangouts_chat_active` | `counts` | | |
| `projects_hipchat_active` | `counts` | | |
| `projects_irker_active` | `counts` | | |
| `projects_jenkins_active` | `counts` | | |
| `projects_jira_active` | `counts` | | |
| `projects_mattermost_active` | `counts` | | |
| `projects_mattermost_slash_commands_active` | `counts` | | |
| `projects_microsoft_teams_active` | `counts` | | |
| `projects_packagist_active` | `counts` | | |
| `projects_pipelines_email_active` | `counts` | | |
| `projects_pivotaltracker_active` | `counts` | | |
| `projects_prometheus_active` | `counts` | | |
| `projects_pushover_active` | `counts` | | |
| `projects_redmine_active` | `counts` | | |
| `projects_slack_active` | `counts` | | |
| `projects_slack_slash_commands_active` | `counts` | | |
| `projects_teamcity_active` | `counts` | | |
| `projects_unify_circuit_active` | `counts` | | |
| `projects_webex_teams_active` | `counts` | | |
| `projects_youtrack_active` | `counts` | | |
| `projects_slack_notifications_active` | `counts` | | |
| `projects_slack_slash_active` | `counts` | | |
| `projects_jira_server_active` | `counts` | | |
| `projects_jira_cloud_active` | `counts` | | |
| `projects_jira_dvcs_cloud_active` | `counts` | | |
| `projects_jira_dvcs_server_active` | `counts` | | |
| `labels` | `counts` | | |
| `merge_requests` | `counts` | | |
| `notes` | `counts` | | |
| `wiki_pages_create` | `counts` | | |
| `wiki_pages_update` | `counts` | | |
| `wiki_pages_delete` | `counts` | | |
| `web_ide_commits` | `counts` | | |
| `web_ide_views` | `counts` | | |
| `web_ide_merge_requests` | `counts` | | |
| `web_ide_previews` | `counts` | | |
| `snippet_comment` | `counts` | | |
| `commit_comment` | `counts` | | |
| `merge_request_comment` | `counts` | | |
| `snippet_create` | `counts` | | |
| `snippet_update` | `counts` | | |
| `navbar_searches` | `counts` | | |
| `cycle_analytics_views` | `counts` | | |
| `productivity_analytics_views` | `counts` | | |
| `source_code_pushes` | `counts` | | |
| `merge_request_create` | `counts` | | |
| `design_management_designs_create` | `counts` | | |
| `design_management_designs_update` | `counts` | | |
| `design_management_designs_delete` | `counts` | | |
| `licenses_list_views` | `counts` | | |
| `user_preferences_group_overview_details` | `counts` | | |
| `user_preferences_group_overview_security_dashboard` | `counts` | | |
| `ingress_modsecurity_logging` | `counts` | | |
| `ingress_modsecurity_blocking` | `counts` | | |
| `ingress_modsecurity_disabled` | `counts` | | |
| `ingress_modsecurity_not_installed` | `counts` | | |
| `dependency_list_usages_total` | `counts` | | |
| `epics` | `counts` | | |
| `feature_flags` | `counts` | | |
| `geo_nodes` | `counts` | | |
| `incident_issues` | `counts` | `monitor` | Issues created by the alert bot |
| `alert_bot_incident_issues` | `counts` | `monitor` | Issues created by the alert bot |
| `incident_labeled_issues` | `counts` | `monitor` | Issues with the incident label |
| `issues_created_gitlab_alerts` | `counts` | `monitor` | Issues created from alerts by non-alert bot users |
| `ldap_group_links` | `counts` | | |
| `ldap_keys` | `counts` | | |
| `ldap_users` | `counts` | | |
| `pod_logs_usages_total` | `counts` | | |
| `projects_enforcing_code_owner_approval` | `counts` | | |
| `projects_mirrored_with_pipelines_enabled` | `counts` | | |
| `projects_reporting_ci_cd_back_to_github` | `counts` | | |
| `projects_with_packages` | `counts` | | |
| `projects_with_prometheus_alerts` | `counts` | | |
| `projects_with_tracing_enabled` | `counts` | | |
| `projects_with_alerts_service_enabled` | `counts` | | |
| `template_repositories` | `counts` | | |
| `container_scanning_jobs` | `counts` | | |
| `dependency_scanning_jobs` | `counts` | | |
| `license_management_jobs` | `counts` | | |
| `sast_jobs` | `counts` | | |
| `status_page_projects` | `counts` | `monitor` | |
| `status_page_issues` | `counts` | `monitor` | |
| `epics_deepest_relationship_level` | `counts` | | |
| `operations_dashboard_default_dashboard` | `counts` | | |
| `operations_dashboard_users_with_projects_added` | `counts` | | |
| `container_registry_enabled` | | | |
| `dependency_proxy_enabled` | | | |
| `gitlab_shared_runners_enabled` | | | |
| `gravatar_enabled` | | | |
| `ldap_enabled` | | | |
| `mattermost_enabled` | | | |
| `omniauth_enabled` | | | |
| `prometheus_metrics_enabled` | | | |
| `reply_by_email_enabled` | | | |
| `average` | `avg_cycle_analytics - code` | | |
| `sd` | `avg_cycle_analytics - code` | | |
| `missing` | `avg_cycle_analytics - code` | | |
| `average` | `avg_cycle_analytics - test` | | |
| `sd` | `avg_cycle_analytics - test` | | |
| `missing` | `avg_cycle_analytics - test` | | |
| `average` | `avg_cycle_analytics - review` | | |
| `sd` | `avg_cycle_analytics - review` | | |
| `missing` | `avg_cycle_analytics - review` | | |
| `average` | `avg_cycle_analytics - staging` | | |
| `sd` | `avg_cycle_analytics - staging` | | |
| `missing` | `avg_cycle_analytics - staging` | | |
| `average` | `avg_cycle_analytics - production` | | |
| `sd` | `avg_cycle_analytics - production` | | |
| `missing` | `avg_cycle_analytics - production` | | |
| `total` | `avg_cycle_analytics` | | |
| `clusters_applications_cert_managers` | `usage_activity_by_stage` | `configure` | |
| `clusters_applications_helm` | `usage_activity_by_stage` | `configure` | |
| `clusters_applications_ingress` | `usage_activity_by_stage` | `configure` | |
| `clusters_applications_knative` | `usage_activity_by_stage` | `configure` | |
| `clusters_management_project` | `usage_activity_by_stage` | `configure` | |
| `clusters_disabled` | `usage_activity_by_stage` | `configure` | |
| `clusters_enabled` | `usage_activity_by_stage` | `configure` | |
| `clusters_platforms_gke` | `usage_activity_by_stage` | `configure` | |
| `clusters_platforms_eks` | `usage_activity_by_stage` | `configure` | |
| `clusters_platforms_user` | `usage_activity_by_stage` | `configure` | |
| `instance_clusters_disabled` | `usage_activity_by_stage` | `configure` | |
| `instance_clusters_enabled` | `usage_activity_by_stage` | `configure` | |
| `group_clusters_disabled` | `usage_activity_by_stage` | `configure` | |
| `group_clusters_enabled` | `usage_activity_by_stage` | `configure` | |
| `project_clusters_disabled` | `usage_activity_by_stage` | `configure` | |
| `project_clusters_enabled` | `usage_activity_by_stage` | `configure` | |
| `projects_slack_notifications_active` | `usage_activity_by_stage` | `configure` | |
| `projects_slack_slash_active` | `usage_activity_by_stage` | `configure` | |
| `projects_with_prometheus_alerts: 0` | `usage_activity_by_stage` | `configure` | |
| `deploy_keys` | `usage_activity_by_stage` | `create` | |
| `keys` | `usage_activity_by_stage` | `create` | |
| `projects_jira_dvcs_server_active` | `usage_activity_by_stage` | `plan` | |
| `service_desk_enabled_projects` | `usage_activity_by_stage` | `plan` | |
| `service_desk_issues` | `usage_activity_by_stage` | `plan` | |
| `todos: 0` | `usage_activity_by_stage` | `plan` | |
| `deployments` | `usage_activity_by_stage` | `release` | |
| `failed_deployments` | `usage_activity_by_stage` | `release` | |
| `projects_mirrored_with_pipelines_enabled` | `usage_activity_by_stage` | `release` | |
| `releases` | `usage_activity_by_stage` | `release` | |
| `successful_deployments: 0` | `usage_activity_by_stage` | `release` | |
| `user_preferences_group_overview_security_dashboard: 0` | `usage_activity_by_stage` | `secure` | |
| `ci_builds` | `usage_activity_by_stage` | `verify` | |
| `ci_external_pipelines` | `usage_activity_by_stage` | `verify` | |
| `ci_internal_pipelines` | `usage_activity_by_stage` | `verify` | |
| `ci_pipeline_config_auto_devops` | `usage_activity_by_stage` | `verify` | |
| `ci_pipeline_config_repository` | `usage_activity_by_stage` | `verify` | |
| `ci_pipeline_schedules` | `usage_activity_by_stage` | `verify` | |
| `ci_pipelines` | `usage_activity_by_stage` | `verify` | |
| `ci_triggers` | `usage_activity_by_stage` | `verify` | |
| `clusters_applications_runner` | `usage_activity_by_stage` | `verify` | |
| `projects_reporting_ci_cd_back_to_github: 0` | `usage_activity_by_stage` | `verify` | |
## Example Usage Ping payload ## Example Usage Ping payload
The following is example content of the Usage Ping payload. The following is example content of the Usage Ping payload.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7