diff --git a/cloud-recording/develop/integration-best-practices.md b/cloud-recording/develop/integration-best-practices.md index 142dc0330..e702210cb 100644 --- a/cloud-recording/develop/integration-best-practices.md +++ b/cloud-recording/develop/integration-best-practices.md @@ -15,49 +15,53 @@ 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. -## 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 (). If your apps already rely heavily on the , contact support@agora.io 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. - -### Check the PCW and QPS limits +## Check the limits -Check that the Peak Concurrent Worker (PCW) and Queries per Second (QPS) values under your App ID do not exceed the Agora 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. -#### PSW +#### PCW -PCW limitations depend on your video stream resolution and region: +The PCW limit depends on your video stream resolution and region. -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:---------------------|:----------------------|:---------------------|:----------------------|:--------------------------------| -| Individual recording | 1000 | 200 | 400 | 300 | -| Composite recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 | - -Resolution description: +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 +- 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 |
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 50
  • HD 30
  • FHD 10
|
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 100
  • HD 50
  • FHD 30
| -If you need to extend the limit for PSW, please contact support@agora.io. +If you need to extend the PCW limit, please contact support@agora.io. #### QPS -The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact support@agora.io. +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 support@agora.io. -### Check the stream limit +#### 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 detailed in the table below: +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 | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 | +| Cloud recording |
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 50
  • HD 30
  • FHD 10
|
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 100
  • HD 50
  • FHD 30
| + +If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams per resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use cloud recording in mainland China to record 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.
 + +## Get service status + +You use Cloud Recording RESTful APIs to get the status of the recording service. -If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams in each resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use cloud recording service in mainland China to record both SD and HD, the total number of streams cannot exceed 100. If you record both HD and FHD, the total number cannot exceed 50.
 +Best practice is that core apps do not rely on (). If your apps already rely heavily on the , contact support@agora.io 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. ### Ensure the recording service starts successfully diff --git a/cloud-recording/develop/webpage-best-practices.md b/cloud-recording/develop/webpage-best-practices.md index eb3887e00..d3e4f71e0 100644 --- a/cloud-recording/develop/webpage-best-practices.md +++ b/cloud-recording/develop/webpage-best-practices.md @@ -21,40 +21,44 @@ 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 PCW and QPS limits +### Check the limits -Check that the Peak Concurrent Worker (PCW) and Queries per Second (QPS) values under your App ID do not exceed the Agora 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. -#### PSW +#### PCW -PCW limitations depend on your video stream resolution and region: +The PCW limit depends on your video stream resolution and region. -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:---------------------|:----------------------|:---------------------|:----------------------|:--------------------------------| -| Web page recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 50, FHD 30 | - -Resolution description: +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 -If you need to extend the limit for PSW, please contact support@agora.io. +| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | +|:---------------------|:------------------------|:-------------------|:--------------------------------|:------------| +| Web page recording |
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 50
  • HD 30
  • FHD 10
|
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 100
  • HD 50
  • FHD 30
| + +If you need to extend the PCW limit, contact support@agora.io. #### QPS -The initial QPS limit is 10 per App ID when you register. You can estimate the QPS that your project needs according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact support@agora.io. +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 support@agora.io. + +#### Number of streams + +The upper limit of video attributes supported by Agora is as follows: -### Check the stream limit +- Resolution 1920 × 1080 +- Frame rate 30 FPS -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 detailed in the table below: +The maximum number of supported streams is as follows: -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:----------------|:----------------------|:---------------------|:----------------------|:--------------------------------| -| Page recording | SD 100, HD 50, FHD 30 | SD 50, HD 30, FHD 10 | SD 100, HD 50, FHD 30 | SD 100, HD 100, FHD 30 | +| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | +|:-------------------|:----------------------|:---------------------|:----------------------|:--------------------------------| +| Web page recording |
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 50
  • HD 30
  • FHD 10
|
  • SD 100
  • HD 50
  • FHD 30
|
  • SD 100
  • HD 50
  • FHD 30
| -If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams in each resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to use the web page recording service in mainland China to record both SD and HD, the total number of streams cannot exceed 100. If you record both HD and FHD, the total number cannot exceed 50.
 +If you need to record multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams per resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need to record in mainland China 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.
 ### Ensure the recording service starts successfully diff --git a/media-pull/develop/integration-best-practices.mdx b/media-pull/develop/integration-best-practices.mdx index a7eb397cf..6c24f54ae 100644 --- a/media-pull/develop/integration-best-practices.mdx +++ b/media-pull/develop/integration-best-practices.mdx @@ -18,13 +18,13 @@ You need the following to start using RESTful API: - is enabled - Message Notification Service is enabled to monitor events -## Limitations +## Check the limits -You are limited in the number of queries per second and concurrent tasks for +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. -### QPS +#### QPS -The following table shows the limits the number of queries per second (QPS) to the RESTful API. +Agora sets the following QPS limits for the RESTful API: |API |QPS limit | |:--------|:---------------------| @@ -32,34 +32,38 @@ The following table shows the limits the number of queries per second (QPS) to t |Delete|Deleting cloud players is limited to 100 queries per second.| |List|
  • For a project with filter, the limit of the query rate is 2 times per second and 15 times per minute.
  • When there is no filter, the limit of query rate is 10 times per second and 20 times per minute.
| -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 support@agora.io. -### PSW +#### PCW -PCW limitations depend on your video stream resolution and region: +The PCW limit depends on your video stream resolution and region. -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| -| Media Pull | SD 20, HD 20, FHD 10 | SD 20, HD 10, FHD 5 |SD 20, HD 10, FHD 5 | SD 20, HD 20, FHD 5 | - -Resolution description: +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 -If you need to extend the limit for PSW, please contact support@agora.io. +| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | +|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| +| Media Pull |
  • SD 20
  • HD 20
  • FHD 10
|
  • SD 20
  • HD 10
  • FHD 5
|
  • SD 20
  • HD 10
  • FHD 5
|
  • SD 20
  • HD 20
  • FHD 5
| + +If you need to extend the PCW limit, contact support@agora.io. ### 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 detailed in the table below: +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) | |:---------------|:----------------------|:---------------------|:----------------------|:--------------------------------| -| Media Pull | SD 20, HD 20, FHD 10 | SD 20, HD 10, FHD 5 | SD 20, HD 10, FHD 5 | SD 20, HD 20, FHD 5 | +| Media Pull |
  • SD 20
  • HD 20
  • FHD 10
|
  • SD 20
  • HD 10
  • FHD 5
|
  • SD 20
  • HD 10
  • FHD 5
|
  • SD 20
  • HD 20
  • FHD 5
| -If you need to pull multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams in each resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need both SD and HD streams in mainland China, the total number of streams cannot exceed 100. For HD and FHD, the total number cannot exceed 50.
 +If you need to inject multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams per resolution cannot exceed the corresponding limit for that resolution.
  • 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 mainland China, the total number of streams cannot exceed 100. If you need to inject HD and FHD, the total number cannot exceed 50.
 ## Ensure the high availability of REST services diff --git a/media-push/develop/integration-best-practices.mdx b/media-push/develop/integration-best-practices.mdx index 8702f82e4..a8185e448 100644 --- a/media-push/develop/integration-best-practices.mdx +++ b/media-push/develop/integration-best-practices.mdx @@ -18,47 +18,54 @@ You need the following to start using Media Push RESTful API: - Media Push is enabled - To monitor Media Push events, enable [](../../video-calling/develop/receive-notifications) (optional). -## Limitations +## 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 Agora server limits the number of queries per second (QPS) to the Media Push RESTful API. -When the QPS is exceeded, the status code `429` (Too Many Requests) -is returned. If you need a higher QPS limit, contact technical support. +#### QPS -|API |QPS limit | -|:---------|:-----------------------------------------------------------------------| +Agora sets the following QPS limits for the Media Push RESTful API: + +|API |QPS limit | +|:---------|:--------------------------------------------------------| |Create |Creating a converter is limited to 50 queries per second.| |Delete |Deleting a converter is limited to 50 queries per second.| |Update |Updating a specified converter is limited to 50 queries per second.| |Get |Getting the request rate of a specified converter is limited to 50 queries per second.| -### PSW +When the QPS limit is exceeded, the status code `429` (Too Many Requests) +is returned. To extend the QPS limit, contact support@agora.io. -PCW limitations depend on your video stream resolution and region: +#### PCW -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| -| Media Push | SD 300, HD 50, FHD 20 | SD 20, HD 5, FHD 0 |SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 | +The PCW limit depends on your video stream resolution and region. -Resolution description: +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 -If you need to extend the limit for PSW, please contact support@agora.io. +| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | +|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| +| Media Push |
  • SD 300
  • HD 50
  • FHD 20
|
  • SD 20
  • HD 5
  • FHD 0
|
  • SD 20
  • HD 5
  • FHD 0
|
  • SD 20
  • HD 5
  • FHD 0
| + +If you need to extend the PCW limit, contact support@agora.io. + +#### Number of streams + +The upper limit of video attributes supported by Agora is as follows: -### Number of streams +- Resolution 1920 × 1080 +- Frame rate 30 FPS -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 detailed in the table below: +The maximum number of supported streams is as follows: -| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | -|:---------------|:----------------------|:---------------------|:----------------------|:--------------------------------| -| Media Push | SD 300, HD 50, FHD 20 | SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 | SD 20, HD 5, FHD 0 | +| Service type | Mainland China | Europe | America | Asia (excluding mainland China) | +|:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| +| Media Push |
  • SD 300
  • HD 50
  • FHD 20
|
  • SD 20
  • HD 5
  • FHD 0
|
  • SD 20
  • HD 5
  • FHD 0
|
  • SD 20
  • HD 5
  • FHD 0
| -If you need to push multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams in each resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you need both SD and HD streams in mainland China, the total number of streams cannot exceed 100. For HD and FHD, the total number cannot exceed 50.
 +If you need to upload multiple streams of different resolutions at the same time, make sure you meet the following requirements:
  • The number of streams per resolution cannot exceed the corresponding limit for that resolution.
  • The total number of streams cannot exceed the limit set for the higher resolution. For example, if you upload both SD and HD streams in mainland China, the total number of streams cannot exceed 100. If you upload HD and FHD, the total number cannot exceed 50.
 ## Ensure the high availability of REST services diff --git a/shared/chat-sdk/reference/_limitations.mdx b/shared/chat-sdk/reference/_limitations.mdx index 6c5d79f64..b085b2f35 100644 --- a/shared/chat-sdk/reference/_limitations.mdx +++ b/shared/chat-sdk/reference/_limitations.mdx @@ -35,6 +35,10 @@ When a group + +### Service limits + +The following limits apply to Peak Concurrent Users (PCU), Peak Concurrent Worker (PCW), and bandwidth: + +* : + + |Item|China|Europe|America|Asia| + |:---|:----|:-----|:------|:---| + |PCU|10,000|10,000|10,000|10,000| + |Bandwidth|10G|10G|10G|10G| + +* Media Push: The limit depends on the video resolution: + + | Item | Mainland China | Europe | America | Asia (excluding mainland China) | + |:-------------|:----------------------|:----------------------|:----------------------|:--------------------------------| + | PCW |
  • SD 200
  • HD 50
  • FHD 20
|
  • SD 50
  • HD 20
  • FHD 5
|
  • SD 50
  • HD 20
  • FHD 5
|
  • SD 50
  • HD 20
  • FHD 5
| + +For Media Push, the limit is reached when at least one of the resolutions exceeds its corresponding value. + +To extend any of those limits, contact support@agora.io. + + + + diff --git a/shared/voice-sdk/get-started/_get-started-sdk.mdx b/shared/voice-sdk/get-started/_get-started-sdk.mdx index aebb8cea0..7309be4c0 100644 --- a/shared/voice-sdk/get-started/_get-started-sdk.mdx +++ b/shared/voice-sdk/get-started/_get-started-sdk.mdx @@ -75,3 +75,20 @@ This section contains information that completes the information in this page, o - To ensure communication security in a test or production environment, use a token server to generate token is recommended to ensure communication security, see [Secure authentication with tokens](../get-started/authentication-workflow). + + + +### Service limits + +The following limits apply to Peak Concurrent Users (PCU) and bandwidth: + +* : + + |Item|China|Europe|America|Asia| + |:---|:----|:-----|:------|:---| + |PCU|10,000|10,000|10,000|10,000| + |Bandwidth|10G|10G|10G|10G| + +To extend any of those limits, contact support@agora.io. + + \ No newline at end of file diff --git a/signaling/reference/limitations.mdx b/signaling/reference/limitations.mdx index 59d199fbd..de42a19b6 100644 --- a/signaling/reference/limitations.mdx +++ b/signaling/reference/limitations.mdx @@ -9,7 +9,20 @@ import Limitations from '@docs/shared/signaling/limitations/index.mdx'; export const toc = [{}]; -A brief overview of the limitations of the Agora , including API call limit, string size, encoding, and more. +This page provides a brief overview of the limitations of the Agora . + +## General + +The following general limits apply: + +|Item |Limit | +|:--------------------------------------------|:------------------| +|RESTful API requests per second per App ID |500 | +|Number of concurrent users |50,000 | +|Number of daily active users |500,000 | +|Number of users in a single channel |50,000 | + +To extend any of the above limits, contact support@agora.io. ## Channel message limit @@ -21,33 +34,14 @@ Agora has the following recommendations on the maximum number of channel message | ≥ 1,000 and < 10,000 | < 100 | | ≥ 10,000 | < 30 | - If the number of messages per second exceeds the recommended values, latency can increase significantly and may also cause the following issues: - The user cannot send or receive messages. - The user always stays in the `RECONNECTING` state or keeps switching between the `CONNECTED` state and the `RECONNECTING` state. For other users, the current user may appear offline. -## Channel member limit - Agora provides customized service to increase the number of messages per second without affecting latency or stability. Please contact support@agora.io for more information. - -## Service quota limits - -The following table lists the service quota limits for . When any of the following indicators exceed the limit, - contact technical support to extend it. - - -|Item |Limit | -|:--------------------------------------------|:------------------| -|RESTful API requests per second per App ID |500 | -|Increment in the number of concurrent users |50,000 | -|Increment in the number of daily active users|500,000 | -|Number of users on a single channel |50,000 | -|The number of users of a single channel is greater than 10,000 and the total number of messages sent by the channel per second is greater than 100 |/ | - - ## Miscellaneous - Notifications of a member joining or leaving the channel are automatically disabled when the number of channel members exceeds 512. diff --git a/video-calling/reference/service-limits.mdx b/video-calling/reference/service-limits.mdx deleted file mode 100644 index 76a1d9d27..000000000 --- a/video-calling/reference/service-limits.mdx +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Service limits -sidebar_position: 1 -description: > - Provides you with information on service limits ---- - -import ServiceLimits from '@docs/shared/video-sdk/reference/_service_limits.mdx'; - -export const toc = [{}] - -