From dc041430aeb15575cbd1db2aaf39010cd293561a Mon Sep 17 00:00:00 2001 From: DMRobertson Date: Wed, 17 Nov 2021 14:20:12 +0000 Subject: deploy: 077b74929f8f412395d1156e1b97eb16701059fa --- .../admin_api/background_updates.html | 306 +++++++++++++++++++++ latest/usage/administration/admin_api/index.html | 2 +- .../admin_api/registration_tokens.html | 2 +- latest/usage/administration/index.html | 2 +- latest/usage/administration/request_log.html | 2 +- 5 files changed, 310 insertions(+), 4 deletions(-) create mode 100644 latest/usage/administration/admin_api/background_updates.html (limited to 'latest/usage/administration') diff --git a/latest/usage/administration/admin_api/background_updates.html b/latest/usage/administration/admin_api/background_updates.html new file mode 100644 index 0000000000..93f1c71086 --- /dev/null +++ b/latest/usage/administration/admin_api/background_updates.html @@ -0,0 +1,306 @@ + + + + + + Background Updates - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + + + + + +
+
+ +
+ +
+ +

Background Updates API

+

This API allows a server administrator to manage the background updates being +run against the database.

+

Status

+

This API gets the current status of the background updates.

+

The API is:

+
GET /_synapse/admin/v1/background_updates/status
+
+

Returning:

+
{
+    "enabled": true,
+    "current_updates": {
+        "<db_name>": {
+            "name": "<background_update_name>",
+            "total_item_count": 50,
+            "total_duration_ms": 10000.0,
+            "average_items_per_ms": 2.2,
+        },
+    }
+}
+
+

enabled whether the background updates are enabled or disabled.

+

db_name the database name (usually Synapse is configured with a single database named 'master').

+

For each update:

+

name the name of the update. +total_item_count total number of "items" processed (the meaning of 'items' depends on the update in question). +total_duration_ms how long the background process has been running, not including time spent sleeping. +average_items_per_ms how many items are processed per millisecond based on an exponential average.

+

Enabled

+

This API allow pausing background updates.

+

Background updates should not be paused for significant periods of time, as +this can affect the performance of Synapse.

+

Note: This won't persist over restarts.

+

Note: This won't cancel any update query that is currently running. This is +usually fine since most queries are short lived, except for CREATE INDEX +background updates which won't be cancelled once started.

+

The API is:

+
POST /_synapse/admin/v1/background_updates/enabled
+
+

with the following body:

+
{
+    "enabled": false
+}
+
+

enabled sets whether the background updates are enabled or disabled.

+

The API returns the enabled param.

+
{
+    "enabled": false
+}
+
+

There is also a GET version which returns the enabled state.

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/latest/usage/administration/admin_api/index.html b/latest/usage/administration/admin_api/index.html index 3cea305feb..7fdf177540 100644 --- a/latest/usage/administration/admin_api/index.html +++ b/latest/usage/administration/admin_api/index.html @@ -99,7 +99,7 @@ diff --git a/latest/usage/administration/admin_api/registration_tokens.html b/latest/usage/administration/admin_api/registration_tokens.html index f2992a7195..f316eb9764 100644 --- a/latest/usage/administration/admin_api/registration_tokens.html +++ b/latest/usage/administration/admin_api/registration_tokens.html @@ -99,7 +99,7 @@ diff --git a/latest/usage/administration/index.html b/latest/usage/administration/index.html index d3e285ab78..c76bbf5053 100644 --- a/latest/usage/administration/index.html +++ b/latest/usage/administration/index.html @@ -99,7 +99,7 @@ diff --git a/latest/usage/administration/request_log.html b/latest/usage/administration/request_log.html index 357b9cfca3..2b413bc0a8 100644 --- a/latest/usage/administration/request_log.html +++ b/latest/usage/administration/request_log.html @@ -99,7 +99,7 @@ -- cgit 1.5.1