-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1495 from AgoraIO/1481-service-quota-notification
Service quota notification
- Loading branch information
Showing
14 changed files
with
293 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: 'Service limits' | ||
sidebar_position: 5 | ||
type: docs | ||
description: > | ||
The service limits imposed by Agora | ||
--- | ||
|
||
import ServiceLimits from '@docs/shared/video-sdk/reference/_service_limits.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<ServiceLimits product="Broadcast Streaming" PATH="broadcast-streaming" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,16 +15,54 @@ To improve application robustness, Agora recommends that you do the following wh | |
|
||
If you send a Cloud Recording RESTful API request to `api.agora.io` and the request fails, retry with the same domain name first. If it fails again, replace the domain name with `api.sd-rtn.com` and retry. Best practice is to first try the DNS domain close to your server. See the [domain name table](#domain-name-table) for a list of DNS servers. | ||
|
||
Agora recommends that you use a backoff strategy, for example, retry after 1, 3, and 6 seconds successively, to avoid exceeding the Queries Per Second (QPS) limits. | ||
Agora recommends that you use a backoff strategy, for example, retry after 1, 3, and 6 seconds successively, to avoid exceeding the Queries Per Second limits. | ||
|
||
## Check the limits | ||
|
||
Check that your Peak Concurrent Worker (PCW), Queries Per Second (QPS), and the number of streams do not exceed the following limits set by Agora. | ||
|
||
#### PCW | ||
|
||
The PCW limit depends on your video stream resolution and region. | ||
|
||
Resolutions: | ||
|
||
- SD: Standard definition video, resolution ≤ 640 × 360 | ||
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360 | ||
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720 | ||
|
||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:---------------------|:-----------------------|:---------|:--------------|:--------------------------------| | ||
| Individual recording | 1000 | 200 | 400 | 300 | | ||
| Composite recording | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 50</li> <li>HD 30</li> <li>FHD 10</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | | ||
|
||
If you need to extend the PCW limit, please contact [email protected]. | ||
|
||
#### QPS | ||
|
||
The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs based on your PCW value and query frequency. If you need to extend the limit for QPS, contact [email protected]. | ||
|
||
#### Number of streams | ||
|
||
The upper limit of video attributes supported by Agora is as follows: | ||
|
||
- Resolution 1920 × 1080 | ||
- Frame rate 30 FPS | ||
|
||
The maximum number of supported streams is as follows: | ||
|
||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:----------------|:----------------------|:---------------------|:----------------------|:--------------------------------| | ||
| Cloud recording | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 50</li> <li>HD 30</li> <li>FHD 10</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | | ||
|
||
<Admonition type="caution" title="Note">If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams per resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use cloud recording in Europe to record in both SD and HD, the total number of streams cannot exceed 50. If you record in both HD and FHD, the total number cannot exceed 30.</li></ul></Admonition> | ||
|
||
## Get service status | ||
|
||
You use Cloud Recording RESTful APIs to get the status of the recording service. | ||
|
||
Best practice is that core apps do not rely on <Vg k="NCS_LONG" /> (<Vg k="NCS" />). If your apps already rely heavily on the <Vg k="NCS" />, contact <a href="mailto:[email protected]">[email protected]</a> and enable the redundant message notification function. This doubles the received notifications and reduces the probability of message loss. After enabling the message notification function, you need to deduplicate messages based on `sid`. Message notification still cannot guarantee a 100% arrival rate. | ||
|
||
The initial QPS limit is 10 per App ID when you register. You can estimate the QPS quota your project needs according to your Peak Concurrent Worker (PCW) quota and query frequency. The initial PCW limit is 50 per AppID when you register. If the RESTful API returns QPS limitation error code `429`, or PCW quota limitation error code `406`, then retry, or contact [email protected] to increase your QPS or PCW quota. | ||
|
||
### Ensure the recording service starts successfully | ||
|
||
Take the following steps to ensure that the recording service starts successfully: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -21,6 +21,45 @@ External factors can cause problems with web page recording, including the follo | |
|
||
To ensure reliability and consistency in the face of network issues, Agora recommends the following best practices. | ||
|
||
### Check the limits | ||
|
||
Check that your Peak Concurrent Worker (PCW), Queries Per Second (QPS), and the number of streams do not exceed the following limits set by Agora. | ||
|
||
#### PCW | ||
|
||
The PCW limit depends on your video stream resolution and region. | ||
|
||
Resolutions: | ||
|
||
- SD: Standard definition video, resolution ≤ 640 × 360 | ||
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360 | ||
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720 | ||
|
||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:---------------------|:------------------------|:-------------------|:--------------------------------|:------------| | ||
| Web page recording | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 50</li> <li>HD 30</li> <li>FHD 10</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | | ||
|
||
If you need to extend the PCW limit, contact [email protected]. | ||
|
||
#### QPS | ||
|
||
The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs based on your PCW value and query frequency. If you need to extend the limit for QPS, contact [email protected]. | ||
|
||
#### Number of streams | ||
|
||
The upper limit of video attributes supported by Agora is as follows: | ||
|
||
- Resolution 1920 × 1080 | ||
- Frame rate 30 FPS | ||
|
||
The maximum number of supported streams is as follows: | ||
|
||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:-------------------|:----------------------|:---------------------|:----------------------|:---------------------------------------------------------| | ||
| Web page recording | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 50</li> <li>HD 30</li> <li>FHD 10</li></ul> | <ul><li>SD 100</li> <li>HD 50</li> <li>FHD 30</li></ul> | <ul><li>SD 100</li> <li>HD 100</li> <li>FHD 30</li></ul> | | ||
|
||
<Admonition type="caution" title="Note">If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams per resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to record in America in both SD and HD, the total number of streams cannot exceed 100. If you record in both HD and FHD, the total number cannot exceed 50.</li></ul></Admonition> | ||
|
||
### Ensure the recording service starts successfully | ||
|
||
Take the following steps to ensure that the recording service starts successfully: | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: 'Service limits' | ||
sidebar_position: 5 | ||
type: docs | ||
description: > | ||
The service limits imposed by Agora | ||
--- | ||
|
||
import ServiceLimits from '@docs/shared/video-sdk/reference/_service_limits.mdx'; | ||
|
||
export const toc = [{}]; | ||
|
||
<ServiceLimits product="Interactive Live Streaming" PATH="interactive-live-streaming" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,28 +16,55 @@ You need the following to start using <Vg k="MPULL" /> RESTful API: | |
|
||
- The scene of the channel is live, profile set to `BROADCASTING` | ||
- <Vg k="MPULL" /> is enabled | ||
- Message Notification Service is enabled to monitor <Vg k="MPULL" /> events | ||
|
||
## Limitations | ||
Agora also recommends enabling the Message Notification Service to monitor <Vg k="MPULL" /> events. | ||
|
||
You are limited in the number of queries per second and concurrent tasks for <Vg k="MPULL" /> | ||
## Check the limits | ||
|
||
### QPS | ||
Check that your Peak Concurrent Worker (PCW), Queries Per Second (QPS), and the number of streams do not exceed the following limits set by Agora. | ||
|
||
The following table shows the limits the number of queries per second (QPS) to the <Vg k="MPULL" /> RESTful API. | ||
#### QPS | ||
|
||
Agora sets the following QPS limits for the <Vg k="MPULL" /> RESTful API: | ||
|
||
|API |QPS limit | | ||
|:--------|:---------------------| | ||
|Create|<ul><li>Creating cloud players with names is limited to 2 queries per second. </li><li>Creating cloud players without names is limited to 50 queries per second.</li></ul>| | ||
|Create|<ul><li>Creating Media Pull tasks (cloud players) with names is limited to 2 queries per second. </li><li>Creating cloud players without names is limited to 50 queries per second.</li></ul>| | ||
|Delete|Deleting cloud players is limited to 100 queries per second.| | ||
|List|<ul><li>For a project with filter, the limit of the query rate is 2 times per second and 15 times per minute.</li><li>When there is no filter, the limit of query rate is 10 times per second and 20 times per minute.</li></ul>| | ||
|
||
When the QPS is exceeded, the status code `429` (Too Many Requests) is returned. If you need a higher QPS limit, contact technical support. | ||
When the QPS limit is exceeded, the status code `429` (Too Many Requests) is returned. To extend the QPS limit, contact [email protected]. | ||
|
||
#### PCW | ||
|
||
The PCW limit depends on your video stream resolution and region. | ||
|
||
Resolutions: | ||
|
||
- SD: Standard definition video, resolution ≤ 640 × 360 | ||
- HD: High definition video, resolution ≤ 1280 × 720 and > 640 × 360 | ||
- FHD: Full HD video, resolution ≤ 1920 × 1080 and > 1280 × 720 | ||
|
||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| | ||
| Media Pull | <ul><li>SD 20</li> <li>HD 20</li> <li>FHD 10</li></ul> | <ul><li>SD 20</li> <li>HD 10</li> <li>FHD 5</li></ul> |<ul><li>SD 20</li> <li>HD 10</li> <li>FHD 5</li></ul> | <ul><li>SD 20</li> <li>HD 20</li> <li>FHD 5</li></ul> | | ||
|
||
If you need to extend the PCW limit, contact [email protected]. | ||
|
||
### Number of streams | ||
|
||
The upper limit of video attributes supported by Agora is as follows: | ||
|
||
- Resolution 1920 × 1080 | ||
- Frame rate 30 FPS | ||
|
||
The maximum number of supported streams is as follows: | ||
|
||
### Maximum number of concurrent tasks | ||
| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | | ||
|:---------------|:----------------------|:---------------------|:----------------------|:--------------------------------| | ||
| Media Pull | <ul><li>SD 20</li> <li>HD 20</li> <li>FHD 10</li></ul> | <ul><li>SD 20</li> <li>HD 10</li> <li>FHD 5</li></ul> |<ul><li>SD 20</li> <li>HD 10</li> <li>FHD 5</li></ul> | <ul><li>SD 20</li> <li>HD 20</li> <li>FHD 5</li></ul> | | ||
|
||
The default maximum number of concurrent tasks is 50, which indicates that a maximum of 50 <Vg k="MPULL" /> tasks can be run simultaneously in one project. | ||
If a higher quota is required, contact technical support. | ||
<Admonition type="caution" title="Important">If you need to inject multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams per resolution cannot exceed the corresponding limit for that resolution.</li><li>The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to inject both SD and HD streams in Europe, the total number of streams cannot exceed 20. If you need to inject HD and FHD, the total number cannot exceed 10.</li></ul></Admonition> | ||
|
||
## Ensure the high availability of REST services | ||
|
||
|
Oops, something went wrong.