Debugging - Revision history

imported>LassiPulkkinen: Add Category:Minecraft Modern.

2024-04-12T01:56:25Z

← Older revision		Revision as of 01:56, 12 April 2024
Line 235:		Line 235:

	</div>		</div>

			[[Category:Minecraft Modern]]

imported>Pokechu22: New launcher has log configs (yay!); provide configs that output XML for use there

2017-02-18T18:36:17Z

New launcher has log configs (yay!); provide configs that output XML for use there

@@ Line 1: / Line 1: @@
-The Notchian client and server (and additionally the launcher) can generate additional log information that what is normally displayed, some of which is extremely helpful for debugging.  This can be done by specifying a custom [http://logging.apache.org/log4j/2.x/manual/configuration.html Log4j configuration] by supplying a <code>-Dlog4j.configurationFile=fullpathtoconfigfile.xml</code> argument to the game:
+The Notchian client and server (and additionally the launcher) can generate additional log information that what is normally displayed, some of which is extremely helpful for debugging.  This can be done by specifying a custom [http://logging.apache.org/log4j/2.x/manual/configuration.html Log4j configuration].
-* [[media:ClientDebugging.png|In the JVM Arguments section of the launcher]]
+The native launcher provides a "Log config" section for doing this directly.  For other situations, this can be done by <code>-Dlog4j.configurationFile=fullpathtoconfigfile.xml</code> argument to the game:
 * Before the <code>-jar</code> in the server launch command
 * Before the <code>-jar</code> when directly invoking the <code>launcher.jar</code>
 {{Warning|If the configuration specified with <code>-Dlog4j.configurationFile</code> cannot be found, the default one will silently be used instead.}}
@@ Line 17: / Line 21: @@
 The other major option is the list of <code><nowiki><filter></nowiki></code>s.  By default, the game filters out information regarding packets with a <code><nowiki><filter></nowiki></code> that rejects all log messages marked with <code>NETWORK_PACKETS</code>.  You can instead make it so that the filter only accepts <code>NETWORK_PACKETS</code> and rejects everything else, or alternatively you can remove the <code><nowiki><filter></nowiki></code> entirely so that all messages are displayed.  Beyond just <code>NETWORK_PACKETS</code>, there are a few other log markers: <code>SOUNDS</code>, <code>NETWORK</code>, <code>PACKET_SENT</code>, and <code>PACKET_RECEIVED</code>.  <code>NETWORK</code> and <code>NETWORK_PACKETS</code> behave identically; <code>PACKET_SENT</code> and <code>PACKET_RECEIVED</code> can be used to show only one set of the packets; and <code>SOUNDS</code> can be used to emit information about when a sound channel starts and stops (mostly only useful when diagnosing issues where a sound seems to be playing twice).
-One other note: by default, log4j overwrites old logs if there are more than 7 for a day (see [https://bugs.mojang.com/browse/MC-100524 MC-100524]).  You can disable this "feature" by adding a <code><nowiki><DefaultRolloverStrategy max="1000"/></nowiki></code> to the <code><nowiki><RollingRandomAccessFile></nowiki></code>, which makes the maximum 1000 files in a day (which is much less likely to be hit - 1000 is used over something larger because at larger numbers there starts to be a performance hit).
+One other note: by default, log4j overwrites old logs if there are more than 7 for a day (see [https://bugs.mojang.com/browse/MC-100524 MC-100524]).  You can disable this behavior by adding a <code><nowiki><DefaultRolloverStrategy max="1000"/></nowiki></code> to the <code><nowiki><RollingRandomAccessFile></nowiki></code>, which makes the maximum 1000 files in a day (which is much less likely to be hit - 1000 is used over something larger because at larger numbers there starts to be a performance hit).
 == Sample configs ==
@@ Line 58: / Line 62: @@
              <AppenderRef ref="File"/>
              <AppenderRef ref="ServerGuiConsole"/>
          </Root>
      </Loggers>
@@ Line 96: / Line 131: @@
              <AppenderRef ref="File"/>
              <AppenderRef ref="ServerGuiConsole"/>
          </Root>
      </Loggers>
@@ Line 142: / Line 205: @@
 ''Applies to: Launcher.jar''
-By enabling debug launching on the launcher jar, you can view connections to the [[Mojang API]] - helpful if you want to see a sample connection to each endpoint for your own account.
+By enabling debug launching on the (Java launcher's) launcher.jar, you can view connections to the [[Mojang API]] - helpful if you want to see a sample connection to each endpoint for your own account.
 Note that this configuration ''may'' not work if you invoke the normal launcher EXE/JAR - instead, use it on the <code>launcher.jar</code> located in <code>%appdata%\.minecraft</code>.

imported>Tachyon: XML error in All debug informations

2017-01-14T12:52:55Z

XML error in All debug informations

← Older revision		Revision as of 12:52, 14 January 2017
Line 73:		Line 73:
	Config:		Config:
	<syntaxhighlight lang="xml" class="mw-collapsible-content">		<syntaxhighlight lang="xml" class="mw-collapsible-content">
	~~<?xml version="1.0" encoding="UTF-8"?>~~
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<Configuration status="WARN" packages="com.mojang.util">		<Configuration status="WARN" packages="com.mojang.util">

imported>Pokechu22: Fix unterminated syntaxhighlight tag

2017-01-10T00:51:53Z

Fix unterminated syntaxhighlight tag

← Older revision		Revision as of 00:51, 10 January 2017
Line 170:		Line 170:
	</Loggers>		</Loggers>
	</Configuration>		</Configuration>
			</syntaxhighlight>

	</div>		</div>

imported>Pokechu22: Add launcher debug config; make Options section useful

2016-11-02T15:35:00Z

Add launcher debug config; make Options section useful

@@ Line 7: / Line 7: @@
 {{Warning|If the configuration specified with <code>-Dlog4j.configurationFile</code> cannot be found, the default one will silently be used instead.}}
 You can get the default configuration for the game by extracting <code>log4j2.xml</code> from the jar you wish to work with.
 == Options ==
-The main settings that are worth modifying is the value of <code>level</code> in <code>Root</code>, and the list of <code>filter</code>s.  (SOUNDS, NETWORK, NETWORK_PACKETS, PACKET_SENT, PACKET_RECEIVED)
+There are only a few options that have useful behaviors within the log4j configuration.
 == Sample configs ==
@@ Line 83: / Line 89: @@
                  <OnStartupTriggeringPolicy />
              </Policies>
          </RollingRandomAccessFile>
      </Appenders>
@@ Line 118: / Line 125: @@
                  <OnStartupTriggeringPolicy />
              </Policies>
          </RollingRandomAccessFile>
      </Appenders>
@@ Line 129: / Line 137: @@
 </Configuration>
 </syntaxhighlight>
 </div>

imported>Pokechu22: Partial rewrite (will expand later)

2016-11-01T21:00:31Z

Partial rewrite (will expand later)

Show changes

imported>Pokechu22: Include fix for https://bugs.mojang.com/browse/MC-100524 by default (especially in debug logs this is important)

2016-06-07T23:32:44Z

Include fix for https://bugs.mojang.com/browse/MC-100524 by default (especially in debug logs this is important)

← Older revision		Revision as of 23:32, 7 June 2016
Line 24:		Line 24:
	<OnStartupTriggeringPolicy />		<OnStartupTriggeringPolicy />
	</Policies>		</Policies>
			<DefaultRolloverStrategy max="999999"/>
	</RollingRandomAccessFile>		</RollingRandomAccessFile>
	</Appenders>		</Appenders>
Line 72:		Line 73:
	<OnStartupTriggeringPolicy />		<OnStartupTriggeringPolicy />
	</Policies>		</Policies>
			<DefaultRolloverStrategy max="999999"/>
	</RollingRandomAccessFile>		</RollingRandomAccessFile>
	</Appenders>		</Appenders>

imported>Pokechu22: Hexadecimal

2016-04-02T15:36:04Z

Hexadecimal

← Older revision		Revision as of 15:36, 2 April 2016
Line 40:		Line 40:

	Doing this will display some packet information in the console. Unfortunately after the netty rewrite (1.7), only packet names and IDs are shown; packet content is no longer given. Nevertheless, this information still can be useful.		Doing this will display some packet information in the console. Unfortunately after the netty rewrite (1.7), only packet names and IDs are shown; packet content is no longer given. Nevertheless, this information still can be useful.

			{{warning\|Packet IDs are shown in decimal in logs; they are not in hexadecimal.}}

	<pre>		<pre>

imported>Pokechu22: More info, more categories.

2016-04-02T15:31:48Z

More info, more categories.

@@ Line 1: / Line 1: @@
-Minecraft's client and server can log every packet which can be helpful for debugging servers.
+Minecraft's client and server can log every packet which can be helpful for debugging.  It can also log a large amount of other information should it be necessary, beyond what is normally found in the logs.
      -Dlog4j.configurationFile=fullpathtoconfigfile.xml
@@ Line 5: / Line 5: @@
 The <code>-Dlog4j.configurationFile=fullpathtoconfigfile.xml</code> should be placed:
 * [[media:ClientDebugging.png|In the JVM Arguments section of the launcher]]
 * Before the <code>-jar</code> in the server launch command
 where the config file should contain
@@ Line 39: / Line 39: @@
 </syntaxhighlight>
-this will display packets in the launcher's console like so:
+Doing this will display some packet information in the console.  Unfortunately after the netty rewrite (1.7), only packet names and IDs are shown; packet content is no longer given.  Nevertheless, this information still can be useful.
 <pre>
-Client> [22:56:42] [Netty Client IO #5/DEBUG]: OUT: [PLAY:3] iq[]
+[08:21:44] [Netty Client IO #0/DEBUG]: OUT: [HANDSHAKING:0] jd
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:21] gw[id=1907, xa=4, ya=0, za=3]
+[08:21:44] [Netty Client IO #0/DEBUG]: OUT: [STATUS:0] jw
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:25] hg[id=1907, rot=-28]
+[08:21:44] [Netty Client IO #0/DEBUG]:  IN: [STATUS:0] js
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:21] gw[id=1903, xa=11, ya=0, za=0]
+[08:21:44] [Netty Client IO #0/DEBUG]: OUT: [STATUS:1] jv
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:22] gy[id=1580, yRot=-49, xRot=0]
+[08:21:44] [Netty Client IO #0/DEBUG]:  IN: [STATUS:1] jr
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:25] hg[id=1580, rot=-49]
+[08:21:52] [Netty Client IO #1/DEBUG]: OUT: [HANDSHAKING:0] jd
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:18] hl[id=1025, x=0.00, y=-0.08, z=-0.01]
+[08:21:52] [Netty Client IO #1/DEBUG]: OUT: [LOGIN:0] jm
-Client> [22:56:42] [Netty Client IO #5/DEBUG]:  IN: [PLAY:21] gw[id=1025, xa=-5, ya=0, za=-2]
+[08:21:52] [Netty Client IO #1/DEBUG]:  IN: [LOGIN:1] ji
 </pre>

imported>Thinkofdeath at 19:19, 17 November 2013

2013-11-17T19:19:00Z

← Older revision		Revision as of 19:19, 17 November 2013
Line 8:		Line 8:

	where the config file should contain		where the config file should contain
	<syntaxhighlight lang="xml~~" enclose="div~~">		<syntaxhighlight lang="xml">
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<Configuration status="WARN" packages="net.minecraft,com.mojang">		<Configuration status="WARN" packages="net.minecraft,com.mojang">