Server Profiling - Revision history

StalEF at 06:28, 9 July 2024

2024-07-09T06:28:30Z

← Older revision		Revision as of 08:28, 9 July 2024
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow Server Owners and Admin to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow Server Owners and Admin to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.
	You can use this generated data to complement issue reports for ~~Strange Loop Games~~.		You can use this generated data to complement issue reports for {{SLG}}.

	'''These instructions are valid for Update 9.6.4 and higher.'''		'''These instructions are valid for Update 9.6.4 and higher.'''

StalEF at 18:08, 20 April 2024

2024-04-20T18:08:14Z

← Older revision		Revision as of 20:08, 20 April 2024
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow Server Owners and Admin to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow Server Owners and Admin to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.
	You can use this generated data to complement issue reports for [[Strange Loop Games~~\|SLG]]~~.		You can use this generated data to complement issue reports for Strange Loop Games.

	'''These instructions are valid for Update 9.6.4 and higher.'''		'''These instructions are valid for Update 9.6.4 and higher.'''

StalEF at 18:06, 20 April 2024

2024-04-20T18:06:56Z

← Older revision		Revision as of 20:06, 20 April 2024
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow ~~[[Server\|~~Server Owners]] and [[Admin~~\|Admins]]~~ to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow Server Owners and Admin to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.
	You can use this generated data to complement issue reports for [[Strange Loop Games\|SLG]].		You can use this generated data to complement issue reports for [[Strange Loop Games\|SLG]].

Dennis: Updated profiling instructions

2022-11-15T11:36:02Z

Updated profiling instructions

← Older revision		Revision as of 13:36, 15 November 2022
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when the server is experiencing performance problems.
	You can use this generated data to complement issue reports for [[Strange Loop Games\|SLG]].		You can use this generated data to complement issue reports for [[Strange Loop Games\|SLG]].

	'''~~Introduced in version~~ 9.5.'''		'''These instructions are valid for Update 9.6.4 and higher.'''
	==Requirements==		==Requirements==
	For profiling to work, you need ~~2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools]~~ installed on your ~~system~~:		For profiling to work, you need several prerequisites installed on your server:
	*[https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump <code>dotnet-dump</code>] - to take memory dumps		#[https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump <code>dotnet-dump</code>] - to take memory dumps (see [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] and note that we don't use dotnet-trace, it doesn't provide useful output)
	*[https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace <code>~~dotnet~~-~~trace~~</code>] - to profile CPU		#<code>[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 dotTrace]</code> - to profile CPU
	You have to make sure ~~both of the tools~~ are installed globally or available on your [[wikipedia:PATH_(variable)\|systems PATH]] so the server can run them.		You have to make sure these are installed globally or available on your [[wikipedia:PATH_(variable)\|systems PATH]] so the server can run them.
	==Memory dumps==		== Memory dumps ==
	For when the server is consuming too much memory.		For when the server is consuming too much memory.

Line 18:		Line 18:
	For when the server is consuming too much CPU.		For when the server is consuming too much CPU.

	CPU profiling can be initiated by:		CPU profiling can be initiated by:
	*As an admin, by issuing <code>/profiler cpu</code> command		*As an admin, by issuing <code>/profiler cpu</code> command
	*Invoking <code>Profiler -> Profile CPU</code> via Server UI Menu (Windows only)		*Invoking <code>Profiler -> Profile CPU</code> via Server UI Menu (Windows only)
	CPU profiling will start the <code>~~dotnet-trace~~</code> process, running it for '''1 minute''', capturing everything going on with the process for the time being.		CPU profiling will start the <code>dotTrace</code> process, running it for '''1 minute''', capturing everything going on with the process for the time being.
	==Full profile==		==Full profile ==
	Full profile will simply take memory dump followed by CPU profiling, as if they were invoked in succession.		Full profile will simply take memory dump followed by CPU profiling, as if they were invoked in succession.

Tom: compliment -> complement

2021-07-13T10:49:56Z

compliment -> complement

← Older revision		Revision as of 12:49, 13 July 2021
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.
	You can use this generated data to ~~compliment~~ issue reports for [[Strange Loop Games\|SLG]].		You can use this generated data to complement issue reports for [[Strange Loop Games\|SLG]].

	'''Introduced in version 9.5.'''		'''Introduced in version 9.5.'''

	==Requirements==		==Requirements==
	For profiling to work, you need 2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] installed on your system:		For profiling to work, you need 2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] installed on your system:

Tom: Reverted comment test

2021-07-13T10:39:20Z

Reverted comment test

← Older revision		Revision as of 12:39, 13 July 2021
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.
	You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].		You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].
	~~<!--~~ Introduced in version 9.5. ~~-->~~
			'''Introduced in version 9.5.'''

	==Requirements==		==Requirements==

Tom: Comment test

2021-07-13T10:39:02Z

Comment test

← Older revision		Revision as of 12:39, 13 July 2021
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.
	You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].		You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].
			<!-- Introduced in version 9.5. -->

	~~'''Introduced in version 9.5.'''~~
	==Requirements==		==Requirements==
	For profiling to work, you need 2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] installed on your system:		For profiling to work, you need 2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] installed on your system:

Tom: Basic formatting updates

2021-07-13T10:38:33Z

Basic formatting updates

← Older revision		Revision as of 12:38, 13 July 2021
Line 1:		Line 1:
	[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.		[[File:In-Game Profiling Commands.png\|thumb\|595x595px\|In-game Admin commands that can be used to invoke profiling sessions\|alt=]][[File:EcoServer Profiling Menu.png\|thumb\|595x595px\|Various profiling options as seen in Server UI (Windows only)\|alt=]]The profiling tools allow [[Server\|Server Owners]] and [[Admin\|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.
			You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].

	~~You can use this generated data to compliment issue reports for [[Strange Loop Games\|SLG]].~~
	'''Introduced in version 9.5.'''		'''Introduced in version 9.5.'''
	==Requirements==		==Requirements==

Tom: Added basic guide for using the Server Profiling tools

2021-07-13T10:36:28Z

Added basic guide for using the Server Profiling tools

New page

[[File:In-Game Profiling Commands.png|thumb|595x595px|In-game Admin commands that can be used to invoke profiling sessions|alt=]][[File:EcoServer Profiling Menu.png|thumb|595x595px|Various profiling options as seen in Server UI (Windows only)|alt=]]The profiling tools allow [[Server|Server Owners]] and [[Admin|Admins]] to run profiling sessions to gather diagnostic data that is especially useful when server is experiencing performance problems.

You can use this generated data to compliment issue reports for [[Strange Loop Games|SLG]].
'''Introduced in version 9.5.'''
==Requirements==
For profiling to work, you need 2 [https://docs.microsoft.com/en-us/dotnet/core/diagnostics/#net-core-diagnostic-global-tools .NET Core diagnostic global tools] installed on your system:
*[https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-dump <code>dotnet-dump</code>] - to take memory dumps
*[https://docs.microsoft.com/en-us/dotnet/core/diagnostics/dotnet-trace <code>dotnet-trace</code>] - to profile CPU
You have to make sure both of the tools are installed globally or available on your [[wikipedia:PATH_(variable)|systems PATH]] so the server can run them.
==Memory dumps==
For when the server is consuming too much memory.

Memory dumps can be initiated by:
*As an admin, by issuing <code>/profiler dump</code> command
*Invoking <code>Profiling -> Take memory dump</code> via Server UI Menu (Windows only)
Memory dump will start the <code>dotnet-dump</code> process, taking a full snapshot of current memory as used by the server process and the file size will be proportional to that. For example, a server that is utilizing 2GB of RAM, the dump file generated will be also 2GB.
==CPU profiling==
For when the server is consuming too much CPU.

CPU profiling can be initiated by:
*As an admin, by issuing <code>/profiler cpu</code> command
*Invoking <code>Profiler -> Profile CPU</code> via Server UI Menu (Windows only)
CPU profiling will start the <code>dotnet-trace</code> process, running it for '''1 minute''', capturing everything going on with the process for the time being.
==Full profile==
Full profile will simply take memory dump followed by CPU profiling, as if they were invoked in succession.