Commit 9c51aeb7 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch 'eread/edit-gitaly-timeouts-docs' into 'master'

Edit Gitaly timeouts documentation

Closes #211325

See merge request gitlab-org/gitlab!42921
parents 7d3865db a0e1453f
...@@ -1021,6 +1021,9 @@ The second facet presents the only real solution. For this, we developed ...@@ -1021,6 +1021,9 @@ The second facet presents the only real solution. For this, we developed
## Troubleshooting Gitaly ## Troubleshooting Gitaly
Check [Gitaly timeouts](../../user/admin_area/settings/gitaly_timeouts.md) when troubleshooting
Gitaly.
### Checking versions when using standalone Gitaly servers ### Checking versions when using standalone Gitaly servers
When using standalone Gitaly servers, you must make sure they are the same version When using standalone Gitaly servers, you must make sure they are the same version
......
...@@ -3,36 +3,28 @@ stage: Create ...@@ -3,36 +3,28 @@ stage: Create
group: Gitaly group: Gitaly
info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers" info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#designated-technical-writers"
type: reference type: reference
type: reference
--- ---
# Gitaly timeouts # Gitaly timeouts **(CORE ONLY)**
![Gitaly timeouts](img/gitaly_timeouts.png)
3 timeout types can be configured to make sure that long running
Gitaly calls don't needlessly take up resources.
- Default timeout
This timeout is the default for most Gitaly calls.
It should be shorter than the worker timeout that can be configured
for
[Puma](https://docs.gitlab.com/omnibus/settings/puma.html#puma-settings)
or [Unicorn](https://docs.gitlab.com/omnibus/settings/unicorn.html).
This makes sure that Gitaly calls made within a web request cannot
exceed these the entire request timeout.
The default for this timeout is 55 seconds. [Gitaly](../../../administration/gitaly/index.md) timeouts are configurable. The timeouts can be
configured to make sure that long running Gitaly calls don't needlessly take up resources.
- Fast timeout To access Gitaly timeout settings:
This is the timeout for very short Gitaly calls. 1. Go to **Admin Area > Settings > Preferences**.
1. Expand the **Gitaly** section.
The default for this timeout is 10 seconds. ## Available timeouts
- Medium timeout The following timeouts can be modified:
This timeout should be between the default and the fast timeout - **Default Timeout Period**. This timeout is the default for most Gitaly calls. It should be shorter than the
worker timeout that can be configured for [Puma](https://docs.gitlab.com/omnibus/settings/puma.html#puma-settings)
or [Unicorn](https://docs.gitlab.com/omnibus/settings/unicorn.html). Used to make sure that Gitaly
calls made within a web request cannot exceed the entire request timeout.
Defaults to 55 seconds.
The default for this timeout is 30 seconds. - **Fast Timeout Period**. This is the timeout for very short Gitaly calls. Defaults to 10 seconds.
- **Medium Timeout Period**. This timeout should be between the default and the fast timeout.
Defaults to 30 seconds.
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