doc: add a note about staggering of maintenance

Commit Message

Shubham Kanodia Oct. 3, 2024, 8:57 a.m. UTC

From: Shubham Kanodia <[e-mail]>

Git maintenance tasks are staggered to a random minute of the hour per
client to avoid thundering herd issues. Updates the doc to add a note
about the same.

Signed-off-by: Shubham Kanodia <[e-mail]>
---
    doc: add a note about staggering of maintenance
    
    Git maintenance tasks are staggered to a random minute of the hour per
    client to avoid thundering herd issues. Updates the doc to add a note
    about the same.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1794%2Fpastelsky%2Fsk%2Fdocs-update-maintenance-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1794/pastelsky/sk/docs-update-maintenance-v1
Pull-Request: https://github.com/git/git/pull/1794

 Documentation/git-maintenance.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)


base-commit: 111e864d69c84284441b083966c2065c2e9a4e78

Comments

Derrick Stolee Oct. 3, 2024, noon UTC | #1

On 10/3/24 4:57 AM, Shubham Kanodia via GitGitGadget wrote:
> From: Shubham Kanodia <[e-mail]>
> 
> Git maintenance tasks are staggered to a random minute of the hour per
> client to avoid thundering herd issues. Updates the doc to add a note
> about the same.

> -tasks for that frequency. Depending on the number of registered
> +tasks for that frequency. The processes are scheduled to a random minute of
> +the hour per client to spread out the load that multiple clients might
> +generate (e.g. from prefetching). Depending on the number of registered
>   repositories and their sizes, this process may take longer than an hour.
Thanks for this update! I'm happy with this version.
-Stolee

Patch

diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt
index 9d968191331..6e6651309d3 100644
--- a/Documentation/git-maintenance.txt
+++ b/Documentation/git-maintenance.txt
@@ -220,7 +220,9 @@  on an hourly basis. Each run executes the "hourly" tasks. At midnight,
 that process also executes the "daily" tasks. At midnight on the first day
 of the week, that process also executes the "weekly" tasks. A single
 process iterates over each registered repository, performing the scheduled
-tasks for that frequency. Depending on the number of registered
+tasks for that frequency. The processes are scheduled to a random minute of
+the hour per client to spread out the load that multiple clients might
+generate (e.g. from prefetching). Depending on the number of registered
 repositories and their sizes, this process may take longer than an hour.
 In this case, multiple `git maintenance run` commands may run on the same
 repository at the same time, colliding on the object database lock. This