10000 Soft coordinator shutdown documentation by neunhoef · Pull Request #14356 · arangodb/arangodb · GitHub
[go: up one dir, main page]
Skip to content

Soft coordinator shutdown documentation #14356

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jul 5, 2021
Merged

Soft coordinator shutdown documentation #14356

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
feb99c4
Add documentation for soft coordinator shutdown.
neunhoef Jun 11, 2021
67a4639
Fix a typo.
neunhoef Jun 11, 2021
74e0f38
Add introduced in.
neunhoef Jun 14, 2021
25c65d6
Apply suggestions from code review
Simran-B Jun 30, 2021
efeb2a3
Update get_api_shutdown.md
Simran-B Jun 30, 2021
34f86c8
Update get_api_shutdown.md
Simran-B Jun 30, 2021
da37502
Update delete_api_shutdown.md
Simran-B Jun 30, 2021
820ff5f
Update get_api_shutdown.md
Simran-B Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
  • Loading branch information
@Simran-B
Simran-B authored Jun 30, 2021
commit 25c65d620d0b1c5fd5aa2dca8fc7587917092b43
41 changes: 34 additions & 7 deletions Documentation/DocuBlocks/Rest/Administration/get_api_shutdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,15 @@
@RESTHEADER{GET /_admin/shutdown, Query progress of soft shutdown process, RestShutdownHandler}

@RESTDESCRIPTION
This call reports progress about a soft coordinator shutdown (see
<small>Introduced in: v3.7.12, v3.8.1, v3.9.0</small>

This call reports progress about a soft Coordinator shutdown (see
documentation of `DELETE /_admin/shutdown?soft=true`).
In this case, the following types of operations are tracked:

- AQL cursors (in particular streaming cursors)
- Transactions (in particular streaming transactions)
- Pregel runs (conducted by this coordinator)
- Transactions (in particular stream transactions)
- Pregel runs (conducted by this Coordinator)
- Ongoing asynchronous requests (using the `x-arango-async: store` HTTP header
- Finished asynchronous requests, whose result has not yet been
collected
Expand All @@ -37,11 +39,36 @@ of the various types:
```

Once all numbers have gone to 0, the flag `allClear` is set and the
coordinator shuts down automatically. This API is not available on
DBServers and Agents.
Coordinator shuts down automatically. This API is not available on
DB-Servers and Agents.


@RESTREPLYBODY{softShutdownOngoing,boolean,required,}
Whether a soft shutdown of the Coordinator is in progress.

@RESTREPLYBODY{AQLcursors,number,required,}
Number of AQL cursors that are still active.

@RESTREPLYBODY{transactions,number,required,}
Number of ongoing transactions.

@RESTREPLYBODY{pendingJobs,number,required,}
Number of ongoing asynchronous requests.

@RESTREPLYBODY{doneJobs,number,required,}
Number of finished asynchronous requests, whose result has not yet been collected.

@RESTREPLYBODY{pregelConductors,number,required,}
Number of ongoing Pregel jobs.

@RESTREPLYBODY{lowPrioOngoingRequests,number,required,}
Number of queued low priority requests.

@RESTREPLYBODY{lowPrioQueuedRequests,number,required,}
Number of ongoing low priority requests.

This API call was introduced in 3.7.12, 3.8.1 and all versions greater
or equal to 3.9.
@RESTREPLYBODY{allClear,boolean,required,}
Whether all active operations finished.

@RESTRETURNCODES

Expand Down
0