Skip to content

Commit

Permalink
Limits added
Browse files Browse the repository at this point in the history
  • Loading branch information
atovpeko committed Oct 20, 2023
1 parent 1a9a3df commit 9139714
Show file tree
Hide file tree
Showing 9 changed files with 162 additions and 113 deletions.
54 changes: 29 additions & 25 deletions cloud-recording/develop/integration-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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.

### 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 | <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 limit for PSW, please contact [email protected].
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 according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact [email protected].
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].

### 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 | <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 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.</li></ul></Admonition>

## Get service status

You use Cloud Recording RESTful APIs to get the status of the recording service.

<Admonition type="caution" title="Important">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 in each 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 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.</li></ul></Admonition>
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.

### Ensure the recording service starts successfully

Expand Down
40 changes: 22 additions & 18 deletions cloud-recording/develop/webpage-best-practices.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected].
| 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 according to your Peak Concurrent Worker (PCW) value and query frequency. If you need to extend the limit for QPS, please contact [email protected].
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:

### 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 | <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="Important">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 in each 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 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.</li></ul></Admonition>
<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 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.</li></ul></Admonition>

### Ensure the recording service starts successfully

Expand Down
38 changes: 21 additions & 17 deletions media-pull/develop/integration-best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,48 +18,52 @@ You need the following to start using <Vg k="MPULL" /> RESTful API:
- <Vg k="MPULL" /> is enabled
- Message Notification Service is enabled to monitor <Vg k="MPULL" /> events

## Limitations
## Check the limits

You are limited in the number of queries per second and concurrent tasks for <Vg k="MPULL" />
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 <Vg k="MPULL" /> RESTful API.
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>|
|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 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 [email protected].
| 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 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 | <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> |

<Admonition type="caution" title="Important">If you need to pull multiple streams of different resolutions at the same time, make sure you meet the following requirements:<ul><li>The number of streams in each 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 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.</li></ul></Admonition>
<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 mainland China, the total number of streams cannot exceed 100. If you need to inject HD and FHD, the total number cannot exceed 50.</li></ul></Admonition>

## Ensure the high availability of REST services

Expand Down
Loading

0 comments on commit 9139714

Please sign in to comment.