Editing Client Profiling

From Eco - English Wiki

Your changes will be displayed to readers once an authorized user accepts them. (help)

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
== Development Build ==
==Server profiling==
In opposite to [[Server Profiling]], the profiling options on this page are only available when playing on a development build.
Server profiling is available in release build both for memory and CPU. For CPU profiling it takes a 1 minute snapshot, for memory it makes a dump file.


You can check if you're running a development build by looking up if this message is present in the right bottom corner:[[File:Development build.png|none|thumb]]
'''During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.'''
==Snapshot==
===Requirements===
You can use the `F6` key to make a snapshot. Check the chat log for output file location details, navigate there with your explorer and attach the file to your report.
1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install
== Transforms Profiling ==
 
# Open Diagnostic Pages UI (with F2).
2. For memory dumps: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump#install
# Go to Transforms page (navigate pages with F3/F4). Page itself significantly impacts performance so keep it closed when you don't need transform updates data.
 
# When you have FPS problems open the page, wait for few seconds and make a screenshot. Attach it to report.
3. For JetBrains dotTrace snapshots: https://www.jetbrains.com/help/profiler/Performance_Profiling__Profiling_Using_the_Command_Line.html#install-and-use-the-command-line-tool-as-a-net-core-tool. For snapshot analysis it requires dotTrace license (trial available), but the snapshot itself can be done without license.
# Then run /savetransformstats command in console, find in same directory as Player.log file named transform-stats.txt and also attach it to report.
===Server GUI===
== Test which objects have the most performance impact ==
Snapshots can be made via the server GUI menu:
# Use /disableobjects {trees,animals,worldobjects,rubbles} (one of the options) to disable rendering of specific group of objects. Then you can check if it fixes your FPS or not. You can also test if with that group disabled you have performance degradation issues or not.
[[File:Server profiling.png|none|thumb]]
# Use /enableobjects all (or speicific group you previously disabled) to re-enable all objects. Though all objects which was previously disabled won't be recovered - you need to re-enter the world or reload these objects by leaving and returning to the area.
===Chat Commands===
May be invoked from game by a user with admin privileges. Mirrors GUI menu commands:
*''/profiler full'' - both CPU (.nettrace) and memory snapshots **(Do not use - nettrace doesn't give insightful results)**
*''/profiler dump'' - memory dump only
*''/profiler cpu'' - CPU (.nettrace) snapshot only **(Do not use - nettrace doesn't give insightful results)**
*''/profiler dottrace'' - dotTrace Timeline snapshot
*''/profiler results'' - opens web page where profiling results may be downloaded
===Output results===
All profiling results are stored in the Server/ProfilingResults directory. You can check the exact log path in the server log. Results are saved as .zip file and may need to be extracted first.
 
.dtt - can be opened JetBrains dotTrace
 
.dmp - Memory dump, can be opened with JetBrains dotMemory, WinDbg or VisualStudio
 
.nettrace - can be opened with PerfView or converted to SpeedScope format.  
 
Read more: https://github.com/dotnet/diagnostics/blob/main/documentation/dotnet-trace-instructions.md#viewing-the-trace-captured-from-dotnet-trace.
 
Results may be accessed via the Web UI as well. It requires admin user permissions (using ''/profiler results'' command).
==Client Profiling==
In a development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.
 
You can check if you're running a development build by looking up if this message is present in the right bottom corner:
[[File:Development build.png|none|thumb]]
Please note that all contributions to Eco - English Wiki are considered to be released under the CC BY-NC-SA 4.0 (see Eco:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.play.eco/en/Client_Profiling"
CC BY-NC-SA 4.0
Powered by MediaWiki