debian-mirror-gitlab/doc/administration/instance_limits.md

443 lines
16 KiB
Markdown
Raw Normal View History

2020-03-13 15:44:24 +05:30
---
type: reference
---
# GitLab application limits
GitLab, like most large applications, enforces limits within certain features to maintain a
minimum quality of performance. Allowing some features to be limitless could affect security,
performance, data, or could even exhaust the allocated resources for the application.
2020-07-28 23:09:34 +05:30
## Rate limits
Rate limits can be used to improve the security and durability of GitLab.
For example, a simple script can make thousands of web requests per second. Whether malicious, apathetic, or just a bug, your application and infrastructure may not be able to cope with the load. Rate limits can help mitigate these types of attacks.
Read more about [configuring rate limits](../security/rate_limits.md) in the Security documentation.
### Issue creation
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28129) in GitLab 12.10.
This setting limits the request rate to the issue creation endpoint.
Read more on [issue creation rate limits](../user/admin_area/settings/rate_limit_on_issues_creation.md).
- **Default rate limit** - Disabled by default
### By User or IP
This setting limits the request rate per user or IP.
Read more on [User and IP rate limits](../user/admin_area/settings/user_and_ip_rate_limits.md).
- **Default rate limit** - Disabled by default
### By raw endpoint
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30829) in GitLab 12.2.
This setting limits the request rate per endpoint.
Read more on [raw endpoint rate limits](../user/admin_area/settings/rate_limits_on_raw_endpoints.md).
- **Default rate limit** - 300 requests per project, per commit and per file path
### By protected path
This setting limits the request rate on specific paths.
GitLab rate limits the following paths by default:
```plaintext
'/users/password',
'/users/sign_in',
'/api/#{API::API.version}/session.json',
'/api/#{API::API.version}/session',
'/users',
'/users/confirmation',
'/unsubscribes/',
'/import/github/personal_access_token',
'/admin/session'
```
Read more on [protected path rate limits](../user/admin_area/settings/protected_paths.md).
- **Default rate limit** - After 10 requests, the client must wait 60 seconds before trying again
### Import/Export
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/35728) in GitLab 13.2.
This setting limits the import/export actions for groups and projects.
| Limit | Default (per minute per user) |
| ----- | ----------------------------- |
| Project Import | 6 |
| Project Export | 6 |
| Project Export Download | 1 |
| Group Import | 6 |
| Group Export | 6 |
| Group Export | Download | 1 |
Read more on [import/export rate limits](../user/admin_area/settings/import_export_rate_limits.md).
### Rack attack
This method of rate limiting is cumbersome, but has some advantages. It allows
throttling of specific paths, and is also integrated into Git and container
registry requests.
Read more on the [Rack Attack initializer](../security/rack_attack.md) method of setting rate limits.
- **Default rate limit** - Disabled
## Gitaly concurrency limit
Clone traffic can put a large strain on your Gitaly service. To prevent such workloads from overwhelming your Gitaly server, you can set concurrency limits in Gitalys configuration file.
Read more on [Gitaly concurrency limits](gitaly/index.md#limit-rpc-concurrency).
- **Default rate limit** - Disabled
2020-03-13 15:44:24 +05:30
## Number of comments per issue, merge request or commit
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22388) in GitLab 12.4.
2020-03-13 15:44:24 +05:30
There's a limit to the number of comments that can be submitted on an issue,
merge request, or commit. When the limit is reached, system notes can still be
added so that the history of events is not lost, but user-submitted comments
will fail.
- **Max limit:** 5.000 comments
2020-04-22 19:07:51 +05:30
## Size of comments and descriptions of issues, merge requests, and epics
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/61974) in GitLab 12.2.
2020-04-22 19:07:51 +05:30
There is a limit to the size of comments and descriptions of issues, merge requests, and epics.
Attempting to add a body of text larger than the limit will result in an error, and the
item will not be created.
It's possible that this limit will be changed to a lower number in the future.
- **Max size:** ~1 million characters / ~1 MB
## Number of issues in the milestone overview
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/39453) in GitLab 12.10.
The maximum number of issues loaded on the milestone overview page is 3000.
When the number exceeds the limit the page displays an alert and links to a paginated
[issue list](../user/project/issues/index.md#issues-list) of all issues in the milestone.
- **Limit:** 3000 issues
2020-03-13 15:44:24 +05:30
## Number of pipelines per Git push
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/51401) in GitLab 11.10.
2020-03-13 15:44:24 +05:30
The number of pipelines that can be created in a single push is 4.
This is to prevent the accidental creation of pipelines when `git push --all`
or `git push --mirror` is used.
Read more in the [CI documentation](../ci/yaml/README.md#processing-git-pushes).
## Retention of activity history
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/21164) in GitLab 8.12.
2020-03-13 15:44:24 +05:30
2020-06-23 00:09:42 +05:30
Activity history for projects and individuals' profiles was limited to one year until [GitLab 11.4](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/52246) when it was extended to two years, and in [GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/33840) to three years.
2020-03-13 15:44:24 +05:30
2020-04-22 19:07:51 +05:30
## Number of embedded metrics
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14939) in GitLab 12.7.
There is a limit when embedding metrics in GFM for performance reasons.
- **Max limit:** 100 embeds
2020-04-08 14:13:33 +05:30
## Number of webhooks
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
On GitLab.com, the [maximum number of webhooks](../user/gitlab_com/index.md#maximum-number-of-webhooks) per project, and per group, is limited.
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
To set this limit on a self-managed installation, run the following in the
2020-04-22 19:07:51 +05:30
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
2020-03-13 15:44:24 +05:30
```ruby
# If limits don't exist for the default plan, you can create one with:
# Plan.default.create_limits!
2020-04-08 14:13:33 +05:30
# For project webhooks
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(project_hooks: 100)
2020-04-08 14:13:33 +05:30
# For group webhooks
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(group_hooks: 100)
2020-03-13 15:44:24 +05:30
```
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
Set the limit to `0` to disable it.
2020-03-13 15:44:24 +05:30
2020-04-22 19:07:51 +05:30
## Incoming emails from auto-responders
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30327) in GitLab 12.4.
2020-04-22 19:07:51 +05:30
GitLab ignores all incoming emails sent from auto-responders by looking for the `X-Autoreply`
header. Such emails don't create comments on issues or merge requests.
## Amount of data sent from Sentry via Error Tracking
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/14926) in GitLab 12.6.
Sentry payloads sent to GitLab have a 1 MB maximum limit, both for security reasons
and to limit memory consumption.
2020-05-24 23:13:21 +05:30
## Max offset allowed via REST API for offset-based pagination
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34565) in GitLab 13.0.
When using offset-based pagination in the REST API, there is a limit to the maximum
requested offset into the set of results. This limit is only applied to endpoints that
support keyset-based pagination. More information about pagination options can be
found in the [API docs section on pagination](../api/README.md#pagination).
To set this limit on a self-managed installation, run the following in the
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
```ruby
# If limits don't exist for the default plan, you can create one with:
# Plan.default.create_limits!
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(offset_pagination_limit: 10000)
2020-05-24 23:13:21 +05:30
```
- **Default offset pagination limit:** 50000
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
Set the limit to `0` to disable it.
2020-05-24 23:13:21 +05:30
2020-03-13 15:44:24 +05:30
## CI/CD limits
### Number of jobs in active pipelines
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32823) in GitLab 12.6.
2020-03-13 15:44:24 +05:30
The total number of jobs in active pipelines can be limited per project. This limit is checked
each time a new pipeline is created. An active pipeline is any pipeline in one of the following states:
- `created`
- `pending`
- `running`
If a new pipeline would cause the total number of jobs to exceed the limit, the pipeline
will fail with a `job_activity_limit_exceeded` error.
- On GitLab.com different [limits are defined per plan](../user/gitlab_com/index.md#gitlab-cicd) and they affect all projects under that plan.
2020-04-08 14:13:33 +05:30
- On [GitLab Starter](https://about.gitlab.com/pricing/#self-managed) tier or higher self-managed installations, this limit is defined for the `default` plan that affects all projects.
2020-03-13 15:44:24 +05:30
This limit is disabled by default.
2020-04-08 14:13:33 +05:30
To set this limit on a self-managed installation, run the following in the
2020-04-22 19:07:51 +05:30
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
2020-03-13 15:44:24 +05:30
```ruby
# If limits don't exist for the default plan, you can create one with:
# Plan.default.create_limits!
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(ci_active_jobs: 500)
2020-03-13 15:44:24 +05:30
```
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
Set the limit to `0` to disable it.
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
### Number of CI/CD subscriptions to a project
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9045) in GitLab 12.9.
2020-04-08 14:13:33 +05:30
The total number of subscriptions can be limited per project. This limit is
checked each time a new subscription is created.
If a new subscription would cause the total number of subscription to exceed the
limit, the subscription will be considered invalid.
- On GitLab.com different [limits are defined per plan](../user/gitlab_com/index.md#gitlab-cicd) and they affect all projects under that plan.
- On [GitLab Starter](https://about.gitlab.com/pricing/#self-managed) tier or higher self-managed installations, this limit is defined for the `default` plan that affects all projects.
To set this limit on a self-managed installation, run the following in the
2020-04-22 19:07:51 +05:30
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
2020-04-08 14:13:33 +05:30
```ruby
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(ci_project_subscriptions: 500)
2020-04-08 14:13:33 +05:30
```
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
Set the limit to `0` to disable it.
2020-04-08 14:13:33 +05:30
### Number of pipeline schedules
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/29566) in GitLab 12.10.
The total number of pipeline schedules can be limited per project. This limit is
checked each time a new pipeline schedule is created. If a new pipeline schedule
would cause the total number of pipeline schedules to exceed the limit, the
pipeline schedule will not be created.
On GitLab.com, different limits are [defined per plan](../user/gitlab_com/index.md#gitlab-cicd),
and they affect all projects under that plan.
On self-managed instances ([GitLab Starter](https://about.gitlab.com/pricing/#self-managed)
or higher tiers), this limit is defined for the `default` plan that affects all
projects. By default, there is no limit.
To set this limit on a self-managed installation, run the following in the
2020-04-22 19:07:51 +05:30
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
2020-04-08 14:13:33 +05:30
```ruby
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(ci_pipeline_schedules: 100)
2020-04-08 14:13:33 +05:30
```
2020-06-23 00:09:42 +05:30
### Number of instance level variables
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216097) in GitLab 13.1.
The total number of instance level CI/CD variables is limited at the instance level.
This limit is checked each time a new instance level variable is created. If a new variable
would cause the total number of variables to exceed the limit, the new variable will not be created.
On self-managed instances this limit is defined for the `default` plan. By default,
this limit is set to `25`.
To update this limit to a new value on a self-managed installation, run the following in the
[GitLab Rails console](troubleshooting/debug.md#starting-a-rails-console-session):
```ruby
2020-07-28 23:09:34 +05:30
Plan.default.actual_limits.update!(ci_instance_level_variables: 30)
2020-06-23 00:09:42 +05:30
```
2020-04-22 19:07:51 +05:30
## Instance monitoring and metrics
### Incident Management inbound alert limits
2020-05-24 23:13:21 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17859) in GitLab 12.5.
2020-04-22 19:07:51 +05:30
Limiting inbound alerts for an incident reduces the number of alerts (issues)
that can be created within a period of time, which can help prevent overloading
your incident responders with duplicate issues. You can reduce the volume of
alerts in the following ways:
- Max requests per period per project, 3600 seconds by default.
- Rate limit period in seconds, 3600 seconds by default.
### Prometheus Alert JSON payloads
2020-05-24 23:13:21 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19940) in GitLab 12.6.
2020-04-22 19:07:51 +05:30
Prometheus alert payloads sent to the `notify.json` endpoint are limited to 1 MB in size.
2020-05-24 23:13:21 +05:30
### Generic Alert JSON payloads
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/16441) in GitLab 12.4.
Alert payloads sent to the `notify.json` endpoint are limited to 1 MB in size.
2020-07-28 23:09:34 +05:30
### Metrics dashboard YAML files
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/34834) in GitLab 13.2.
The memory occupied by a parsed metrics dashboard YAML file cannot exceed 1 MB.
The maximum depth of each YAML file is limited to 100. The maximum depth of a YAML
file is the amount of nesting of its most nested key. Each hash and array on the
path of the most nested key counts towards its depth. For example, the depth of the
most nested key in the following YAML is 7:
```yaml
dashboard: 'Test dashboard'
links:
- title: Link 1
url: https://gitlab.com
panel_groups:
- group: Group A
priority: 1
panels:
- title: "Super Chart A1"
type: "area-chart"
y_label: "y_label"
weight: 1
max_value: 1
metrics:
- id: metric_a1
query_range: 'query'
unit: unit
label: Legend Label
```
2020-03-13 15:44:24 +05:30
## Environment data on Deploy Boards
[Deploy Boards](../user/project/deploy_boards.md) load information from Kubernetes about
Pods and Deployments. However, data over 10 MB for a certain environment read from
Kubernetes won't be shown.
## Merge Request reports
Reports that go over the 20 MB limit won't be loaded. Affected reports:
2020-06-23 00:09:42 +05:30
- [Merge Request security reports](../user/project/merge_requests/testing_and_reports_in_merge_requests.md#security-reports-ultimate)
2020-03-13 15:44:24 +05:30
- [CI/CD parameter `artifacts:expose_as`](../ci/yaml/README.md#artifactsexpose_as)
- [JUnit test reports](../ci/junit_test_reports.md)
## Advanced Global Search limits
### Maximum field length
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/201826) in GitLab 12.8.
2020-03-13 15:44:24 +05:30
You can set a limit on the content of text fields indexed for Global Search.
Setting a maximum helps to reduce the load of the indexing processes. If any
text field exceeds this limit then the text will be truncated to this number of
characters and the rest will not be indexed and hence will not be searchable.
- On GitLab.com this is limited to 20000 characters
2020-04-08 14:13:33 +05:30
- For self-managed installations it is unlimited by default
2020-03-13 15:44:24 +05:30
2020-04-08 14:13:33 +05:30
This limit can be configured for self-managed installations when [enabling
2020-03-13 15:44:24 +05:30
Elasticsearch](../integration/elasticsearch.md#enabling-elasticsearch).
2020-07-28 23:09:34 +05:30
NOTE: **Note:**
Set the limit to `0` to disable it.
2020-03-13 15:44:24 +05:30
## Wiki limits
- [Length restrictions for file and directory names](../user/project/wiki/index.md#length-restrictions-for-file-and-directory-names).
2020-04-22 19:07:51 +05:30
2020-05-24 23:13:21 +05:30
## Snippets limits
See the [documentation on Snippets settings](snippets/index.md).
2020-07-28 23:09:34 +05:30
## Design Management limits
See the [Design Management Limitations](../user/project/issues/design_management.md#limitations) section.
2020-04-22 19:07:51 +05:30
## Push Event Limits
### Webhooks and Project Services
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31009) in GitLab 12.4.
2020-04-22 19:07:51 +05:30
Total number of changes (branches or tags) in a single push. If changes are more
than the specified limit, hooks won't be executed.
More information can be found in these docs:
- [Webhooks push events](../user/project/integrations/webhooks.md#push-events)
- [Project services push hooks limit](../user/project/integrations/overview.md#push-hooks-limit)
### Activities
2020-06-23 00:09:42 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31007) in GitLab 12.4.
2020-04-22 19:07:51 +05:30
Total number of changes (branches or tags) in a single push to determine whether
individual push events or bulk push event will be created.
More information can be found in the [Push event activities limit and bulk push events documentation](../user/admin_area/settings/push_event_activities_limit.md).