Skip to content

Commit

Permalink
update Open Source Docs from Roblox internal teams
Browse files Browse the repository at this point in the history
  • Loading branch information
rbx-open-source-docs[bot] committed Dec 5, 2024
1 parent 6ba08cf commit be526a6
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 7 deletions.
4 changes: 2 additions & 2 deletions content/en-us/cloud/open-cloud/usage-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{asset
<TabItem label="Metadata">

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

```bash title ="Example Request for Updating Both Asset Content and Metadata"
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
curl --location --request PATCH 'https://apis.roblox.com/assets/v1/assets/{assetId}?updateMask=description%2CdisplayName' \
--header 'x-api-key: {apiKey}' \
--form 'request={
\"assetType\": \"{assetType}\",
Expand Down
19 changes: 16 additions & 3 deletions content/en-us/performance-optimization/identifying.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,21 @@ To check the frame rate of your experience:
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.
</Alert>

## Memory
## Server Memory

Try to keep server memory usage below 50%. Total server memory uses the following formula:

`6.25 GiB + (100 MiB * largest_number_of_connected_players)`

<Alert severity="info">
These numbers use powers of 2, so 1 GiB refers to 2^30 bytes and 1 MiB to 2^20 bytes.
</Alert>

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.

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.

## Client Memory

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

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

- 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%.
- A crash occurs while testing on a device that you want your experience to support.
- Your server memory usage exceeds 3 GB.

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:
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:

- **GraphicsMeshParts** - Graphics memory consumed by meshes.
- **GraphicsTexture** - Graphics memory consumed by textures.
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/production/analytics/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The **Client** tab includes the following charts, all of which are broken down b
</tr>
<tr>
<td>Client memory usage</td>
<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>
<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>
</tr>
<tr>
<td>Client memory usage percentage</td>
Expand Down
2 changes: 1 addition & 1 deletion content/en-us/studio/microprofiler/modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Counters mode is a lengthy list of categories and statistics, including instance
- Right-click a graph to close it.
- You can't filter this view, but you can left-click on a category (for example, `memory`) to collapse it.

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.
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.

## Hidden Mode

Expand Down

0 comments on commit be526a6

Please sign in to comment.