diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-05 21:09:17 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-05 21:09:17 +0300 |
commit | 6ba372cf11e46ec9841b511f327155968f51f2ac (patch) | |
tree | a94d622bb3a92093bc522a52c0ebbf505f70109f /doc/development | |
parent | e2937892231e082f4981c31e25cb8d1cca36ea60 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/application_limits.md | 12 | ||||
-rw-r--r-- | doc/development/internal_api.md | 4 | ||||
-rw-r--r-- | doc/development/migration_style_guide.md | 28 | ||||
-rw-r--r-- | doc/development/usage_ping/metrics_dictionary.md | 1 |
4 files changed, 30 insertions, 15 deletions
diff --git a/doc/development/application_limits.md b/doc/development/application_limits.md index 3608636dd55..c42e9224105 100644 --- a/doc/development/application_limits.md +++ b/doc/development/application_limits.md @@ -139,14 +139,14 @@ end Self-managed: -- `default` - Everyone +- `default`: Everyone. GitLab.com: -- `default` - Any system-wide feature -- `free` - Namespaces and projects with a Free subscription -- `bronze`- Namespaces and projects with a Bronze subscription -- `silver` - Namespaces and projects with a Silver subscription -- `gold` - Namespaces and projects with a Gold subscription +- `default`: Any system-wide feature. +- `free`: Namespaces and projects with a Free subscription. +- `bronze`: Namespaces and projects with a Bronze subscription. This tier is no longer available for purchase. +- `silver`: Namespaces and projects with a Premium subscription. +- `gold`: Namespaces and projects with an Ultimate subscription. The `test` environment doesn't have any plans. diff --git a/doc/development/internal_api.md b/doc/development/internal_api.md index 4710ae4606c..7c4f869d1a7 100644 --- a/doc/development/internal_api.md +++ b/doc/development/internal_api.md @@ -488,7 +488,7 @@ POST /namespaces/:id/gitlab_subscription | `plan_code` | string | no | Subscription tier code | | `seats` | integer | no | Number of seats in subscription | | `max_seats_used` | integer | no | Highest number of active users in the last month | -| `auto_renew` | boolean | no | Whether subscription will auto renew on end date | +| `auto_renew` | boolean | no | Whether subscription auto-renews on end date | | `trial` | boolean | no | Whether subscription is a trial | | `trial_starts_on` | date | no | Start date of trial | | `trial_ends_on` | date | no | End date of trial | @@ -539,7 +539,7 @@ PUT /namespaces/:id/gitlab_subscription | `plan_code` | string | no | Subscription tier code | | `seats` | integer | no | Number of seats in subscription | | `max_seats_used` | integer | no | Highest number of active users in the last month | -| `auto_renew` | boolean | no | Whether subscription will auto renew on end date | +| `auto_renew` | boolean | no | Whether subscription auto-renews on end date | | `trial` | boolean | no | Whether subscription is a trial | | `trial_starts_on` | date | no | Start date of trial. Required if trial is true. | | `trial_ends_on` | date | no | End date of trial | diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md index 759b19db36f..dd193ac9022 100644 --- a/doc/development/migration_style_guide.md +++ b/doc/development/migration_style_guide.md @@ -374,7 +374,7 @@ standard Rails migration helper methods. Calling more than one migration helper is not a problem if they're executed on the same table. Using the `with_lock_retries` helper method is advised when a database -migration involves one of the [high-traffic tables](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml#L3). +migration involves one of the [high-traffic tables](#high-traffic-tables). Example changes: @@ -606,7 +606,7 @@ we have to employ `add_concurrent_foreign_key` and `add_concurrent_index` instead of `add_reference`. If you have a new or empty table that doesn't reference a -[high-traffic table](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml#L3), +[high-traffic table](#high-traffic-tables), we recommend that you use `add_reference` in a single-transaction migration. You can combine it with other operations that don't require `disable_ddl_transaction!`. @@ -709,11 +709,8 @@ Dropping a database table is uncommon, and the `drop_table` method provided by Rails is generally considered safe. Before dropping the table, please consider the following: -If your table has foreign keys on a high-traffic table (like `projects`), then -the `DROP TABLE` statement might fail with **statement timeout** error. Determining -what tables are high traffic can be difficult. Self-managed instances might -use different features of GitLab with different usage patterns, thus making -assumptions based on GitLab.com is not enough. +If your table has foreign keys on a [high-traffic table](#high-traffic-tables) (like `projects`), then +the `DROP TABLE` statement is likely to stall concurrent traffic until it fails with **statement timeout** error. Table **has no records** (feature was never in use) and **no foreign keys**: @@ -1028,3 +1025,20 @@ D, [2020-07-06T00:37:12.653459 #130101] DEBUG -- : AddAndSeedMyColumn::User Up D, [2020-07-06T00:37:12.653648 #130101] DEBUG -- : ↳ config/initializers/config_initializers_active_record_locking.rb:13:in `_update_row' == 20200705232821 AddAndSeedMyColumn: migrated (0.1706s) ===================== ``` + +## High traffic tables + +Here's a list of current [high-traffic tables](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml). + +Determining what tables are high-traffic can be difficult. Self-managed instances might use +different features of GitLab with different usage patterns, thus making assumptions based +on GitLab.com not enough. + +To identify a high-traffic table for GitLab.com the following measures are considered. +Note that the metrics linked here are GitLab-internal only: + +- [Read operations](https://thanos.gitlab.net/graph?g0.range_input=2h&g0.max_source_resolution=0s&g0.expr=topk(500%2C%20sum%20by%20(relname)%20(rate(pg_stat_user_tables_seq_tup_read%7Benvironment%3D%22gprd%22%7D%5B12h%5D)%20%2B%20rate(pg_stat_user_tables_idx_scan%7Benvironment%3D%22gprd%22%7D%5B12h%5D)%20%2B%20rate(pg_stat_user_tables_idx_tup_fetch%7Benvironment%3D%22gprd%22%7D%5B12h%5D)))&g0.tab=1) +- [Number of records](https://thanos.gitlab.net/graph?g0.range_input=2h&g0.max_source_resolution=0s&g0.expr=topk(500%2C%20sum%20by%20(relname)%20(rate(pg_stat_user_tables_n_live_tup%7Benvironment%3D%22gprd%22%7D%5B12h%5D)))&g0.tab=1) +- [Size](https://thanos.gitlab.net/graph?g0.range_input=2h&g0.max_source_resolution=0s&g0.expr=topk(500%2C%20sum%20by%20(relname)%20(rate(pg_total_relation_size_bytes%7Benvironment%3D%22gprd%22%7D%5B12h%5D)))&g0.tab=1) is greater than 10 GB + +Any table which has some high read operation compared to current [high-traffic tables](https://gitlab.com/gitlab-org/gitlab/-/blob/master/rubocop/rubocop-migrations.yml#L4) might be a good candidate. diff --git a/doc/development/usage_ping/metrics_dictionary.md b/doc/development/usage_ping/metrics_dictionary.md index 1407a356363..3f43aaa916f 100644 --- a/doc/development/usage_ping/metrics_dictionary.md +++ b/doc/development/usage_ping/metrics_dictionary.md @@ -41,6 +41,7 @@ Each metric is defined in a separate YAML file consisting of a number of fields: | `milestone` | no | The milestone when the metric is introduced. | | `milestone_removed` | no | The milestone when the metric is removed. | | `introduced_by_url` | no | The URL to the Merge Request that introduced the metric. | +| `skip_validation` | no | This should **not** be set. [Used for imported metrics until we review, update and make them valid](https://gitlab.com/groups/gitlab-org/-/epics/5425). | ### Example YAML metric definition |