Debug Profiler - Revision history

ChampionAsh5357: Update debug profiler to 1.17, come back later to address new profiling information

2021-07-29T22:26:40Z

Update debug profiler to 1.17, come back later to address new profiling information

ShrimpBot: Categorize with Category:Beginner Topics by SizableShrimp#0755

2021-05-19T00:58:55Z

Categorize with Category:Beginner Topics by SizableShrimp#0755

SciWhiz12: add under construction template, use tip templates

2020-12-20T17:50:04Z

add under construction template, use tip templates

Unbekannt: update Block to Colored Box

2020-12-19T08:38:16Z

update Block to Colored Box

SciWhiz12: SciWhiz12 moved page Using the Debug Profiler to Debug Profiler without leaving a redirect: Shorten page title, as the old one has unnecessary text

2020-10-24T23:12:59Z

SciWhiz12 moved page Using the Debug Profiler to Debug Profiler without leaving a redirect: Shorten page title, as the old one has unnecessary text

Unbekannt: Some debugging

2020-10-24T13:29:03Z

Some debugging

Unbekannt: Inital import from dokuwiki

2020-10-24T13:18:07Z

Inital import from dokuwiki

New page

= Debug Profiler = Minecraft provides a Debug Profiler that can be used to find time consuming code. Specially considering things like TickEvents and Ticking TileEntities this can be very useful for modders and server owners that want to find a lag source. == Using the Debug Profiler == The Debug Profiler is very simple to use. It requires two commands <code><nowiki>/debug start</nowiki></code>, which starts the profiling process, and <code><nowiki>/debug stop</nowiki></code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute. Naturally, you can only profile code paths that are actually being reached. Entities and TileEntities that you want to profile must exist in the world to show up in the results. After you’ve stopped the debugger it will create a new file, it can be found within the <code><nowiki>debug</nowiki></code> subdirectory in your run directory. The file name will be formatted with the date and time as <code><nowiki>profile-results-yyyy-mm-dd_hh.mi.ss.txt</nowiki></code>. == Reading a Profiling result == At the top it first tells you how long in milliseconds it was running and how many ticks ran in that time. Below that, you will find information similar to the snippet below: <code>[00] levels - 96.70%/96.70% [01] | World Name - 99.76%/96.47% [02] | | tick - 99.31%/95.81% [03] | | | entities - 47.72%/45.72% [04] | | | | regular - 98.32%/44.95% [04] | | | | blockEntities - 0.90%/0.41% [05] | | | | | unspecified - 64.26%/0.26% [05] | | | | | minecraft:furnace - 33.35%/0.14% [05] | | | | | minecraft:chest - 2.39%/0.01%</code> Here is a small explanation of what each part means 
{| class="wikitable" style="width: 850px;" data-mce-style="width: 850px;"
|-
| style="width: 188px;" data-mce-style="width: 188px;"|[02] 
| style="width: 191px;" data-mce-style="width: 191px;"|tick 
| style="width: 237px;" data-mce-style="width: 237px;"|99.31% 
| style="width: 89px;" data-mce-style="width: 89px;"|95.81% 
|-
| style="width: 188px;" data-mce-style="width: 188px;"|The Depth of the section 
| style="width: 191px;" data-mce-style="width: 191px;"|The Name of the Section 
| style="width: 237px;" data-mce-style="width: 237px;"|The percentage of time it took in relation to it’s parent. For Layer 0 it’s the percentage of the time a tick takes, while for Layer 1 it’s the percentage of the time its parent takes 
| style="width: 89px;" data-mce-style="width: 89px;"|The second Percentage tells you how much Time it took from the entire tick. 
|}
 == Profiling your own code == The Debug Profiler has basic support for <code><nowiki>Entity</nowiki></code> and <code><nowiki>TileEntity</nowiki></code>. If you would like to profile something else, you may need to manually create your sections like so: <code> Profiler#startSection(yourSectionName : String); ''The code you want to profile Profiler#endSection(); </code> You can obtain the the <code><nowiki>Profiler</nowiki></code> instance from a <code><nowiki>World</nowiki></code>, <code><nowiki>MinecraftServer</nowiki></code>, or <code><nowiki>Minecraft</nowiki></code> instance. Now you just need to search the File for your section name.

@@ Line 1: / Line 1: @@
 {{Under construction}}
-Minecraft provides a Debug Profiler that can be used to find time consuming code. Specially considering things like TickEvents and Ticking TileEntities this can be very useful for modders and server owners that want to find a lag source.
+Minecraft provides a Debug Profiler that provides system data, current game settings, JVM data, level data, and sided tick information to find time consuming code. Considering things like TickEvents and ticking BlockEntities, this can be very useful for modders and server owners that want to find a lag source.
 == Using the Debug Profiler ==
-The Debug Profiler is very simple to use. It requires two commands <code>/debug start</code>, which starts the profiling process, and <code>/debug stop</code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute.
+The Debug Profiler is very simple to use. The keybind <code>F3 + L</code> can be used to start the profiler. After 10 seconds, the profiler will automatically stop; however, it can be stopped earlier by pressing the keybind again.
-{{Tip|You can only profile code paths that are actually being reached. Entities and Tile Entities that you want to profile must exist in the world to show up in the results.}}
+{{Tip/Important| The <code>/debug</code> still runs; however, no data will be dumped to any location.}}
-After you’ve stopped the debugger it will create a new file, it can be found within the <code>debug</code> subdirectory in your run directory. The file name will be formatted with the date and time as <code>profile-results-yyyy-mm-dd_hh.mi.ss.txt</code>.
+{{Tip|You can only profile code paths that are actually being reached. Entities and Block Entities that you want to profile must exist in the level to show up in the results.}}
 == Reading a Profiling result ==
-At the top it first tells you how long in milliseconds it was running and how many ticks ran in that time.
+Within each sided folder (<code>client</code> and <code>server</code>), you will find a <code>profiling.txt</code> file containing the result data. At the top, it first tells you how long in milliseconds it was running and how many ticks ran in that time.
 Below that, you will find information similar to the snippet below:
@@ Line 19: / Line 21: @@
 <syntaxhighlight>
 [00] levels - 96.70%/96.70%
-[01] |   World Name - 99.76%/96.47%
+[01] |   Level Name - 99.76%/96.47%
 [02] |   |   tick - 99.31%/95.81%
 [03] |   |   |   entities - 47.72%/45.72%
@@ Line 40: / Line 42: @@
 == Profiling your own code ==
-The Debug Profiler has basic support for <code>Entity</code> and <code>TileEntity</code>. If you would like to profile something else, you may need to manually create your sections like so:
+The Debug Profiler has basic support for <code>Entity</code> and <code>BlockEntity</code>. If you would like to profile something else, you may need to manually create your sections like so:
 <syntaxhighlight lang="java">
@@ Line 48: / Line 50: @@
 </syntaxhighlight>
-You can obtain the the <code>Profiler</code> instance from a <code>World</code>, <code>MinecraftServer</code>, or <code>Minecraft</code> instance. Now you just need to search the file for your section name.
+You can obtain the the <code>ProfilerFiller</code> instance from a <code>Level</code>, <code>MinecraftServer</code>, or <code>Minecraft</code> instance. Now you just need to search the file for your section name.
 [[Category:Beginner Topics]]

← Older revision		Revision as of 00:58, 19 May 2021
Line 49:		Line 49:

	You can obtain the the <code>Profiler</code> instance from a <code>World</code>, <code>MinecraftServer</code>, or <code>Minecraft</code> instance. Now you just need to search the file for your section name.		You can obtain the the <code>Profiler</code> instance from a <code>World</code>, <code>MinecraftServer</code>, or <code>Minecraft</code> instance. Now you just need to search the file for your section name.
		+
		+
		+	[[Category:Beginner Topics]]

@@ Line 1: / Line 1: @@
 Minecraft provides a Debug Profiler that can be used to find time consuming code. Specially considering things like TickEvents and Ticking TileEntities this can be very useful for modders and server owners that want to find a lag source.
 == Using the Debug Profiler ==
-The Debug Profiler is very simple to use. It requires two commands <code><nowiki>/debug start</nowiki></code>, which starts the profiling process, and <code><nowiki>/debug stop</nowiki></code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute.
+The Debug Profiler is very simple to use. It requires two commands <code>/debug start</code>, which starts the profiling process, and <code>/debug stop</code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute.
-{{Colored box|title=Tip|content=Naturally, you can only profile code paths that are actually being reached. Entities and TileEntities that you want to profile must exist in the world to show up in the results.}}
+{{Tip|You can only profile code paths that are actually being reached. Entities and Tile Entities that you want to profile must exist in the world to show up in the results.}}
-After you’ve stopped the debugger it will create a new file, it can be found within the <code><nowiki>debug</nowiki></code> subdirectory in your run directory. The file name will be formatted with the date and time as <code><nowiki>profile-results-yyyy-mm-dd_hh.mi.ss.txt</nowiki></code>.
+After you’ve stopped the debugger it will create a new file, it can be found within the <code>debug</code> subdirectory in your run directory. The file name will be formatted with the date and time as <code>profile-results-yyyy-mm-dd_hh.mi.ss.txt</code>.
 == Reading a Profiling result ==
@@ Line 29: / Line 31: @@
 Here is a small explanation of what each part means
-{| class="wikitable sortable" border=1
+{| class="wikitable"
-! [02]  !! tick  !! 99.31%  !! 95.81%
+! [02] !! tick !! 99.31% !! 95.81%
 |-
 |  The Depth of the section  ||  The Name of the Section  ||  The percentage of time it took in relation to it’s parent. For Layer 0 it’s the percentage of the time a tick takes, while for Layer 1 it’s the percentage of the time its parent takes  ||  The second Percentage tells you how much Time it took from the entire tick.
@@ Line 38: / Line 40: @@
 == Profiling your own code ==
-The Debug Profiler has basic support for <code><nowiki>Entity</nowiki></code> and <code><nowiki>TileEntity</nowiki></code>. If you would like to profile something else, you may need to manually create your sections like so:
+The Debug Profiler has basic support for <code>Entity</code> and <code>TileEntity</code>. If you would like to profile something else, you may need to manually create your sections like so:
-<syntaxhighlight lang="Java">
+<syntaxhighlight lang="java">
-  Profiler#startSection(yourSectionName : String);
+profiler.startSection("<a custom section name>");
-  ''The code you want to profile
+// The code you want to profile
-  Profiler#endSection();
+profiler.endSection(); // OR profier.endStartSection("<new section name>");
 </syntaxhighlight>
-You can obtain the the <code><nowiki>Profiler</nowiki></code> instance from a <code><nowiki>World</nowiki></code>, <code><nowiki>MinecraftServer</nowiki></code>, or <code><nowiki>Minecraft</nowiki></code> instance. Now you just need to search the File for your section name.
+You can obtain the the <code>Profiler</code> instance from a <code>World</code>, <code>MinecraftServer</code>, or <code>Minecraft</code> instance. Now you just need to search the file for your section name.

@@ Line 5: / Line 5: @@
 The Debug Profiler is very simple to use. It requires two commands <code><nowiki>/debug start</nowiki></code>, which starts the profiling process, and <code><nowiki>/debug stop</nowiki></code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute.
-<block tip>
+{{Colored box|title=Tip|content=Naturally, you can only profile code paths that are actually being reached. Entities and TileEntities that you want to profile must exist in the world to show up in the results.}}
 After you’ve stopped the debugger it will create a new file, it can be found within the <code><nowiki>debug</nowiki></code> subdirectory in your run directory. The file name will be formatted with the date and time as <code><nowiki>profile-results-yyyy-mm-dd_hh.mi.ss.txt</nowiki></code>.

@@ Line 1: / Line 1: @@
-= Debug Profiler =<br /><br />Minecraft provides a Debug Profiler that can be used to find time consuming code. Specially considering things like TickEvents and Ticking TileEntities this can be very useful for modders and server owners that want to find a lag source.<br /><br />== Using the Debug Profiler ==<br /><br />The Debug Profiler is very simple to use. It requires two commands <code><nowiki>/debug start</nowiki></code>, which starts the profiling process, and <code><nowiki>/debug stop</nowiki></code>, which ends it. The important part here is that the more time you give it to collect the data the better the results will be. It is recommended to at least let it collect data for a minute.<br /><br /><br />Naturally, you can only profile code paths that are actually being reached. Entities and TileEntities that you want to profile must exist in the world to show up in the results.<br /><br /><br />After you’ve stopped the debugger it will create a new file, it can be found within the <code><nowiki>debug</nowiki></code> subdirectory in your run directory. The file name will be formatted with the date and time as <code><nowiki>profile-results-yyyy-mm-dd_hh.mi.ss.txt</nowiki></code>.<br /><br />== Reading a Profiling result ==<br /><br />At the top it first tells you how long in milliseconds it was running and how many ticks ran in that time.<br /><br />Below that, you will find information similar to the snippet below:<br /><br /><br /><code>[00] levels - 96.70%/96.70%<br />[01] | World Name - 99.76%/96.47%<br />[02] | | tick - 99.31%/95.81%<br />[03] | | | entities - 47.72%/45.72%<br />[04] | | | | regular - 98.32%/44.95%<br />[04] | | | | blockEntities - 0.90%/0.41%<br />[05] | | | | | unspecified - 64.26%/0.26%<br />[05] | | | | | minecraft:furnace - 33.35%/0.14%<br />[05] | | | | | minecraft:chest - 2.39%/0.01%</code><br /><br /><br />Here is a small explanation of what each part means<br />
+Minecraft provides a Debug Profiler that can be used to find time consuming code. Specially considering things like TickEvents and Ticking TileEntities this can be very useful for modders and server owners that want to find a lag source.
-{| class="wikitable" style="width: 850px;" data-mce-style="width: 850px;"
 |-
-| style="width: 188px;" data-mce-style="width: 188px;"|[02]<br />
+|  The Depth of the section  ||  The Name of the Section  ||  The percentage of time it took in relation to it’s parent. For Layer 0 it’s the percentage of the time a tick takes, while for Layer 1 it’s the percentage of the time its parent takes  ||  The second Percentage tells you how much Time it took from the entire tick.
 |-
 |}
-<br />== Profiling your own code ==<br /><br />The Debug Profiler has basic support for <code><nowiki>Entity</nowiki></code> and <code><nowiki>TileEntity</nowiki></code>. If you would like to profile something else, you may need to manually create your sections like so:<br /><br /><code><br /> Profiler#startSection(yourSectionName : String);<br /> ''The code you want to profile<br /> Profiler#endSection();<br /></code><br /><br />You can obtain the the <code><nowiki>Profiler</nowiki></code> instance from a <code><nowiki>World</nowiki></code>, <code><nowiki>MinecraftServer</nowiki></code>, or <code><nowiki>Minecraft</nowiki></code> instance. Now you just need to search the File for your section name.

← Older revision	Revision as of 23:12, 24 October 2020
(No difference)