Skip to content

Commit be526a6

Browse files
update Open Source Docs from Roblox internal teams
1 parent 6ba08cf commit be526a6

File tree

4 files changed

+20
-7
lines changed

4 files changed

+20
-7
lines changed

content/en-us/cloud/open-cloud/usage-assets.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{asset
231231
<TabItem label="Metadata">
232232

233233
```bash title ="Example Request for Updating Asset Metadata"
234-
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
234+
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
235235
--header 'x-api-key;' \
236236
--form 'request={
237237
\"assetType\": \"{assetType}\",
@@ -246,7 +246,7 @@ curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/v1/ass
246246
<TabItem label="Content and Metadata">
247247

248248
```bash title ="Example Request for Updating Both Asset Content and Metadata"
249-
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
249+
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
250250
--header 'x-api-key: {apiKey}' \
251251
--form 'request={
252252
\"assetType\": \"{assetType}\",

content/en-us/performance-optimization/identifying.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,21 @@ To check the frame rate of your experience:
8989
When evaluating frame rate, it can help to set the graphics quality to its maximum value to remove the effect of the frame rate manager. In the client, open the menu, click **Settings**, change **Graphics Mode** to manual, and raise graphics quality.
9090
</Alert>
9191

92-
## Memory
92+
## Server Memory
93+
94+
Try to keep server memory usage below 50%. Total server memory uses the following formula:
95+
96+
`6.25 GiB + (100 MiB * largest_number_of_connected_players)`
97+
98+
<Alert severity="info">
99+
These numbers use powers of 2, so 1 GiB refers to 2^30 bytes and 1 MiB to 2^20 bytes.
100+
</Alert>
101+
102+
For example, a server with 30 connected players has approximately 9.18 GiB of total memory. Servers gain memory when players connect, but **don't** lose it when players disconnect. If 10 players leave, the server still has 9.18 GiB of memory rather than shrinking to 8.2 GiB.
103+
104+
When servers shut down (for example, when they are empty or as part of the [update process](../production/publishing/publishing-experiences-and-places.md#updating-experiences)), their replacements start with the base amount of memory and begin scaling up as players connect.
105+
106+
## Client Memory
93107

94108
There are several ways to check memory usage for an experience:
95109

@@ -100,9 +114,8 @@ High memory usage is not necessarily indicative of a problem, but some indicatio
100114

101115
- A significant percentage of client crashes showing in the **Performance Dashboard**, particularly a sudden uptick that coincides with an update. Some number of crashes are expected, but you should investigate if your crash rates increase above 2-3%.
102116
- A crash occurs while testing on a device that you want your experience to support.
103-
- Your server memory usage exceeds 3 GB.
104117

105-
A significant portion of an experience's memory consumption on the client are from assets, such as images and meshes, loaded into graphics memory so they can be rendered. In the **Developer console**, you can view the graphics memory consumed by assets under the following labels:
118+
A significant portion of an experience's memory consumption on the client are from assets, such as images and meshes, loaded into graphics memory so they can be rendered. In the **Developer Console**, check the following labels:
106119

107120
- **GraphicsMeshParts** - Graphics memory consumed by meshes.
108121
- **GraphicsTexture** - Graphics memory consumed by textures.

content/en-us/production/analytics/performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The **Client** tab includes the following charts, all of which are broken down b
6868
</tr>
6969
<tr>
7070
<td>Client memory usage</td>
71-
<td>Line graph showing client memory usage by device type. Continual increases can indicate a memory leak. See [Memory](../../performance-optimization/identifying.md#memory).</td>
71+
<td>Line graph showing client memory usage by device type. Continual increases can indicate a memory leak. See [Memory](../../performance-optimization/identifying.md#client-memory).</td>
7272
</tr>
7373
<tr>
7474
<td>Client memory usage percentage</td>

content/en-us/studio/microprofiler/modes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Counters mode is a lengthy list of categories and statistics, including instance
9494
- Right-click a graph to close it.
9595
- You can't filter this view, but you can left-click on a category (for example, `memory`) to collapse it.
9696

97-
While counters mode can be useful, the [Developer Console](../../studio/optimization/memory-usage.md) is the recommended way to [identify memory issues](../../performance-optimization/identifying.md#memory). You might also find the [X-ray view](index.md#using-the-web-ui) in the web UI helpful for identifying when problematic memory allocation occurs.
97+
While counters mode can be useful, the [Developer Console](../../studio/optimization/memory-usage.md) is the recommended way to [identify memory issues](../../performance-optimization/identifying.md#client-memory). You might also find the [X-ray view](index.md#using-the-web-ui) in the web UI helpful for identifying when problematic memory allocation occurs.
9898

9999
## Hidden Mode
100100

0 commit comments

Comments
 (0)