debian-mirror-gitlab/doc/user/admin_area/settings/gitaly_timeouts.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

27 lines
3.6 KiB
Markdown
Raw Normal View History

2020-04-08 14:13:33 +05:30
---
2022-08-13 15:12:31 +05:30
stage: Systems
2020-10-24 23:57:45 +05:30
group: Gitaly
2022-11-25 23:54:43 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-04-08 14:13:33 +05:30
---
2021-03-11 19:13:27 +05:30
# Gitaly timeouts **(FREE SELF)**
2020-04-08 14:13:33 +05:30
2021-01-03 14:25:43 +05:30
[Gitaly](../../../administration/gitaly/index.md) timeouts are configurable. The timeouts can be
2021-09-30 23:02:18 +05:30
configured to make sure that long-running Gitaly calls don't needlessly take up resources.
2020-04-08 14:13:33 +05:30
2021-01-03 14:25:43 +05:30
To access Gitaly timeout settings:
2020-04-08 14:13:33 +05:30
2022-10-11 01:57:18 +05:30
1. On the top bar, select **Main menu > Admin**.
2021-09-04 01:27:46 +05:30
1. On the left sidebar, select **Settings > Preferences**.
2021-09-30 23:02:18 +05:30
1. Expand the **Gitaly timeouts** section.
2020-04-08 14:13:33 +05:30
2021-01-03 14:25:43 +05:30
## Available timeouts
2020-04-08 14:13:33 +05:30
2021-09-30 23:02:18 +05:30
The following timeouts are available.
2020-04-08 14:13:33 +05:30
2021-09-30 23:02:18 +05:30
| Timeout | Default | Description |
|:--------|:-----------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2022-05-07 20:08:51 +05:30
| Default | 55 seconds | Timeout for most Gitaly calls (not enforced for `git` `fetch` and `push` operations, or Sidekiq jobs). For example, checking if a repository exists on disk. Makes sure that Gitaly calls made within a web request cannot exceed the entire request timeout. It should be shorter than the [worker timeout](../../../administration/operations/puma.md#change-the-worker-timeout) that can be configured for [Puma](../../../install/requirements.md#puma-settings). If a Gitaly call timeout exceeds the worker timeout, the remaining time from the worker timeout is used to avoid having to terminate the worker. |
2021-09-30 23:02:18 +05:30
| Fast | 10 seconds | Timeout for fast Gitaly operations used within requests, sometimes multiple times. For example, checking if a repository exists on disk. If fast operations exceed this threshold, there may be a problem with a storage shard. Failing fast can help maintain the stability of the GitLab instance. |
| Medium | 30 seconds | Timeout for Gitaly operations that should be fast (possibly within requests) but preferably not used multiple times within a request. For example, loading blobs. Timeout that should be set between Default and Fast. |