Client Profiling - Revision history

Dennis at 11:41, 15 November 2022

2022-11-15T11:41:12Z

← Older revision		Revision as of 13:41, 15 November 2022
Line 1:		Line 1:
	==~~General Profiling~~==		== Development Build ==
	In a development build ~~you can use the `F6` key to make a snapshot. Check the chat log for output file location details~~.		In opposite to [[Server Profiling]], the profiling options on this page are only available when playing on a development build.

	You can check if you're running a development build by looking up if this message is present in the right bottom corner:		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]]
	[[File:Development build.png\|none\|thumb]]		==Snapshot==
			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.
	== Transforms Profiling ==		== Transforms Profiling ==
	# Open Diagnostic Pages UI (with F2).		# Open Diagnostic Pages UI (with F2).

Dennis at 11:13, 15 November 2022

2022-11-15T11:13:03Z

← Older revision		Revision as of 13:13, 15 November 2022
Line 4:		Line 4:
	You can check if you're running a development build by looking up if this message is present in the right bottom corner:		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]]		[[File:Development build.png\|none\|thumb]]

	== Transforms Profiling ==		== Transforms Profiling ==

	# Open Diagnostic Pages UI (with F2).		# Open Diagnostic Pages UI (with F2).
	# 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.		# 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.		# When you have FPS problems open the page, wait for few seconds and make a screenshot. Attach it to report.
	# Then run /savetransformstats command in console, find in same directory as Player.log file named transform-stats..txt and also attach it to report.		# Then run /savetransformstats command in console, find in same directory as Player.log file named transform-stats.txt and also attach it to report.

	== Test which objects have the most performance impact ==		== Test which objects have the most performance impact ==

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

Dennis: Changed to client profiling only, added new profiling methods.

2022-11-15T11:08:07Z

Changed to client profiling only, added new profiling methods.

← Older revision		Revision as of 13:08, 15 November 2022
Line 1:		Line 1:
	==~~Server profiling~~==		==General Profiling==
	~~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.		In a development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.

	'~~''During creation of the snapshot it~~ is ~~expected to have increased CPU usage, which may cause~~ in ~~game lags.'''~~		You can check if you're running a development build by looking up if this message is present in the right bottom corner:
	~~===Requirements===~~		[[File:Development build.png\|none\|thumb]]
	~~1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install~~

	~~2. For memory dumps: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump#install~~

	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.
	~~===Server GUI===~~
	~~Snapshots can be made via~~ the ~~server GUI menu~~:
	[[File:~~Server profiling~~.png\|none\|thumb]]
	~~===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~~		== Transforms Profiling ==

	.~~nettrace~~ - ~~can be opened with PerfView or converted~~ to ~~SpeedScope format~~.		# Open Diagnostic Pages UI (with F2).
			# 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.
			# Then run /savetransformstats command in console, find in same directory as Player.log file named transform-stats..txt and also attach it to report.

	~~Read more: https://github.com/dotnet/diagnostics/blob/main/documentation/dotnet-trace-instructions.md#viewing-~~the~~-trace-captured-from-dotnet-trace.~~		== Test which objects have the most performance impact ==

	~~Results may be accessed via~~ the ~~Web UI as well. It requires admin user permissions (using ''/profiler results'' command~~).		# 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.
	~~==Client Profiling==~~		# 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.
	~~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]]~~

Dennis: Dennis moved page Performance Profiling to Client Profiling without leaving a redirect: We already had a page for server profiling.

2022-11-15T11:04:42Z

Dennis moved page Performance Profiling to Client Profiling without leaving a redirect: We already had a page for server profiling.

← Older revision		Revision as of 13:04, 15 November 2022
(No difference)

Dennis at 07:15, 15 November 2022

2022-11-15T07:15:16Z

← Older revision		Revision as of 09:15, 15 November 2022
Line 1:		Line 1:
	==Server profiling==		==Server profiling==
	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.		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.

	'''During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.'''		'''During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.'''
	===Requirements===		===Requirements===
	1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install		1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install
Line 32:		Line 32:
	Results may be accessed via the Web UI as well. It requires admin user permissions (using ''/profiler results'' command).		Results may be accessed via the Web UI as well. It requires admin user permissions (using ''/profiler results'' command).
	==Client Profiling==		==Client Profiling==
	In ~~the~~ development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.		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:		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]]		[[File:Development build.png\|none\|thumb]]

Dennis: /* Server profiling */

2022-11-15T07:14:31Z

Server profiling

← Older revision		Revision as of 09:14, 15 November 2022
Line 1:		Line 1:
	==Server profiling==		==Server profiling==
	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.		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.
	~~<nowiki></nowiki>~~During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.
			'''During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.'''
	===Requirements===		===Requirements===
	1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install		1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install
Line 20:		Line 21:
	===Output results===		===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.		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		.dtt - can be opened JetBrains dotTrace

	.dmp - Memory dump, can be opened with JetBrains dotMemory, WinDbg or VisualStudio		.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).		.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==		==Client Profiling==
	In the development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.		In the development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.

Dennis: /* Client Profiling */

2022-11-15T07:13:27Z

Client Profiling

← Older revision		Revision as of 09:13, 15 November 2022
Line 11:		Line 11:
	Snapshots can be made via the server GUI menu:		Snapshots can be made via the server GUI menu:
	[[File:Server profiling.png\|none\|thumb]]		[[File:Server profiling.png\|none\|thumb]]

	===Chat Commands===		===Chat Commands===
	May be invoked from game by a user with admin privileges. Mirrors GUI menu commands:		May be invoked from game by a user with admin privileges. Mirrors GUI menu commands:
Line 28:		Line 27:
	==Client Profiling==		==Client Profiling==
	In the development build you can use the `F6` key to make a snapshot. Check the chat log for output file location details.		In the 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:		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]]		[[File:Development build.png\|none\|thumb]]

Dennis: Created page for profiling.

2022-11-15T07:11:53Z

Created page for profiling.

New page

==Server profiling==
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.
<nowiki>**</nowiki>During creation of the snapshot it is expected to have increased CPU usage, which may cause in game lags.**
===Requirements===
1. For dotnet trace CPU snapshots: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace#install

2. For memory dumps: https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump#install

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.
===Server GUI===
Snapshots can be made via the server GUI menu:
[[File:Server profiling.png|none|thumb]]

===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 the 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]]