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 13, 2024
1 parent be08a92 commit 18eef33
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 10 deletions.
3 changes: 3 additions & 0 deletions content/en-us/assets/analytics/performance/perf-dash-dev.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 8 additions & 4 deletions content/en-us/production/analytics/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,21 @@ The server CPU and memory charts default to the **Overall** view, but have dropd

If a category is higher than usual or appears to be taking up a disproportionate amount of time, use the dropdown menu to drill down on the group and identify processes that could be causing issues.

<img src="../../assets/analytics/performance/perf-dash-drilldown.png" alt="The server CPU time chart showing the physics dropdown." width="600px" />
<img src="../../assets/analytics/performance/perf-dash-drilldown.png" alt="The server CPU time chart showing the physics dropdown." width="700px" />

<Alert severity="success">
To exclude a group or process from a chart, click its label in the legend.
</Alert>

The categories in the dropdown menu map to the ones in the [MicroProfiler](../../studio/microprofiler/index.md), so you can open the MicroProfiler, select **Detailed** or **Timers** modes, and then use the **Groups** menu to filter by the problematic process group.
- CPU categories and tasks map to the ones in the [MicroProfiler](../../studio/microprofiler/index.md), so you can take [server dumps](../../studio/microprofiler/index.md#profiling-the-server), select **Timers** mode, and then use the **Groups** menu to filter by the problematic process group.

For example, if you spot a potential problem with the **assemble** process under the **Physics** group, you can find it under the same name in the MicroProfiler:
For example, if you spot a potential problem with the **assemble** process under the **Physics** group, you can find it under the same name in the MicroProfiler:

<img src="../../assets/analytics/performance/perf-dash-micro.png" alt="The MicroProfiler showing the assemble process within the Physics group." width="500px" />
<img src="../../assets/analytics/performance/perf-dash-micro.png" alt="The MicroProfiler showing the assemble process within the Physics group." width="700px" />

- Memory tags map to the ones in `Enum.DeveloperMemoryTag`, with the notable exception of **CoreMemory:Total**, which is equivalent to `Enum.DeveloperMemoryTag.Internal`. You can use the [Developer Console](../../studio/optimization/memory-usage.md#memory) to check tags for excessive usage. This image shows how you might use the Developer Console to investigate an issue with **PlaceMemory:GraphicsTexture** that you see in the dashboard:

<img src="../../assets/analytics/performance/perf-dash-dev.png" alt="The Developer Console showing the server memory view." width="750px" />

## Troubleshooting

Expand Down
4 changes: 2 additions & 2 deletions content/en-us/resources/feature-packages/bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,7 @@ Consider the following best practice guidance on redundant recordings of Receipt

Constants for the **Core** feature package live in two spots:

- Shared constants live in `ReplicatedStorage.FeaturePackageCore.Configs.SharedConstants`.
- Shared constants live in `ReplicatedStorage.FeaturePackagesCore.Configs.SharedConstants`.

- Package-specific constants, in this case the **Bundles** feature package, live in `ReplicatedStorage.Bundles.Configs.Constants`.

Expand All @@ -399,7 +399,7 @@ The main things you might want to adjust to meet the design requirements of your
- Purchase effect duration and particle colors
- Heads up display collapsibility

Additionally, you can find strings for translation broken out into one location: `ReplicatedStorage.FeaturePackageCore.Configs.TranslationStrings`.
Additionally, you can find strings for translation broken out into one location: `ReplicatedStorage.FeaturePackagesCore.Configs.TranslationStrings`.

## Customizing UI Components

Expand Down
4 changes: 2 additions & 2 deletions content/en-us/resources/feature-packages/missions.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,11 +370,11 @@ You mainly need to hook up four things once dragging the **Missions** feature pa

Constants for the **Core** feature package live in two spots:

- Shared constants live in `ReplicatedStorage.FeaturePackageCore.Configs.SharedConstants`.
- Shared constants live in `ReplicatedStorage.FeaturePackagesCore.Configs.SharedConstants`.

- Package-specific constants, in this case the **Missions** feature package, live in `ReplicatedStorage.Missions.Configs.Constants`.

Additionally, you can find strings for translation broken out into one location: `ReplicatedStorage.FeaturePackageCore.Configs.TranslationStrings`.
Additionally, you can find strings for translation broken out into one location: `ReplicatedStorage.FeaturePackagesCore.Configs.TranslationStrings`.

## Customizing UI Components

Expand Down

0 comments on commit 18eef33

Please sign in to comment.