DXSpider Tracing Debug Entries - Revision history

WI3W: add perl regex document

2025-04-14T17:10:33Z

add perl regex document

← Older revision		Revision as of 17:10, 14 April 2025
Line 86:		Line 86:
	or you can use 'tee -a' to append to the file:		or you can use 'tee -a' to append to the file:
	grepdbg 1 gb7tlh \| tee -a trace.txt		grepdbg 1 gb7tlh \| tee -a trace.txt

			===Other Resources===
			Please see the "perlre" document here: [https://perldoc.perl.org/perlre/ Perl Regex Document]

WI3W: Grammar

2025-04-05T22:01:35Z

Grammar

← Older revision		Revision as of 22:01, 5 April 2025
Line 5:		Line 5:
	This guide assumes that 'watchdbg' has been linked to /usr/local/bin. If not, you can run this command in Linux:		This guide assumes that 'watchdbg' has been linked to /usr/local/bin. If not, you can run this command in Linux:
	sudo ln -s /spider/perl/*dbg /usr/local/bin		sudo ln -s /spider/perl/*dbg /usr/local/bin
	This ~~will~~ command will link all dbg subroutines in /spider/perl to /usr/local/bin so they can be accessed from the user prompt like any other built in command.		This command will link all dbg subroutines in /spider/perl to /usr/local/bin so they can be accessed from the user prompt like any other built in command.

	==== watchdbg ====		==== watchdbg ====

WI3W: WI3W moved page Tracing Input / Output Frames from Your Node to DXSpider Tracing Debug Entries: More inclusive title.

2025-04-05T21:47:54Z

WI3W moved page Tracing Input / Output Frames from Your Node to DXSpider Tracing Debug Entries: More inclusive title.

← Older revision		Revision as of 21:47, 5 April 2025
(No difference)

WI3W: Changing "Saving to a file" hierarchy.

2025-04-05T21:45:29Z

Changing "Saving to a file" hierarchy.

← Older revision		Revision as of 21:45, 5 April 2025
Line 73:		Line 73:
	Note: these filters are being used in the shell, certain characters will need to be escaped and certain regex strings will need to be quoted.		Note: these filters are being used in the shell, certain characters will need to be escaped and certain regex strings will need to be quoted.

	==== Saving to a file ====		=== Saving to a file ===
	It is possible to save the output of these commands to a specific file by using the redirection operator " > " or " >> "in Linux. The " > " will overwrite a file and " >> " will append to a file. Both operators will create a file if it does not exist. Ex:		It is possible to save the output of these commands to a specific file by using the redirection operator " > " or " >> "in Linux. The " > " will overwrite a file and " >> " will append to a file. Both operators will create a file if it does not exist. Ex:
	watchdbg ' D ' 'PC[16]1' >> trace.txt		watchdbg ' D ' 'PC[16]1' >> trace.txt

WI3W: Saving progress...

2025-04-05T21:43:48Z

Saving progress...

← Older revision		Revision as of 21:43, 5 April 2025
Line 33:		Line 33:
	1;		1;
	</syntaxhighlight>It can also have a 'sub begin {...}' and / or 'sub end {...}' which are executed immediately after opening a logfile and then just before closing it, respectively. You can also add a 'sub total {...}' which executes after the last line is printed and grepdbg exits. Read the code of this program and copy'n'paste the 'sub process' code into a new file. Then change 'sub process' to 'sub handle'. Add the line 'package main;' at the beginning of the file and a line '1;' at the end and then modify it to your requirements...		</syntaxhighlight>It can also have a 'sub begin {...}' and / or 'sub end {...}' which are executed immediately after opening a logfile and then just before closing it, respectively. You can also add a 'sub total {...}' which executes after the last line is printed and grepdbg exits. Read the code of this program and copy'n'paste the 'sub process' code into a new file. Then change 'sub process' to 'sub handle'. Add the line 'package main;' at the beginning of the file and a line '1;' at the end and then modify it to your requirements...
	===Filtering ~~traces~~===		===Filtering===

	Regexes can be debug levels, nodes, or even a strings of text. See Wikipedia for a basic [[wikipedia:Regular_expression\|regex]] explanation. [https://regex101.com/ Regex101] is a good place to practice.		Regexes can be debug levels, nodes, or even a strings of text. See Wikipedia for a basic [[wikipedia:Regular_expression\|regex]] explanation. [https://regex101.com/ Regex101] is a good place to practice. Just be aware that DXSpider and it's associated programs use the Perl flavor of regex.

	To trace incoming messages the I is used, and for outbound the D is used:		To trace incoming messages the I is used, and for outbound the D is used:
Line 49:		Line 49:
	"chan\|progress"		"chan\|progress"
	This regex will hit on any debug entry with the level label of "chan" or "progress".		This regex will hit on any debug entry with the level label of "chan" or "progress".

			A more complex example using Perl regex AND ( .* ) and OR ( \| ):
			"wi3w\-3.ea2cw\-4\|ea2cw\-4.wi3w\-3"
			This regex will hit on any match of wi3w-3 and ea2cw-4 in that order OR any match of ea2cw-4 and wi3w-3 in that order.

	=== Trace examples ===		=== Trace examples ===
Line 57:		Line 61:
	The same can be done for inbound traffic:		The same can be done for inbound traffic:
	watchdbg '<\- I' or watchdbg ' I '		watchdbg '<\- I' or watchdbg ' I '
	or ~~two~~ watch all inbound PC92 frames:		or to watch all inbound PC92 frames:
	watchdbg ' I ' 'PC92'		watchdbg ' I ' 'PC92'
	Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.		Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.
			grepdbg '<\- I GB7TLH' or grepdbg ' I ' 'gb7tlh'
			This command will grep from the current day's debug file and filter on all incoming traffic from the node GB7TLH. Again, the spaces are important as they mimic the format of the debug log entries.
			grepdbg 2 -5 gb7tlh
			This command will hit on anything with 'gb7tlh' in it from 2 days ago and will show the 5 entries before the hit.
			grepdbg "connect.*(gb7tlh\|wi3w\-3)"
			This command will hit on any debug entry with the 'connect' AND either GB7TLH OR WI3W-3 in that order.

			Note: these filters are being used in the shell, certain characters will need to be escaped and certain regex strings will need to be quoted.

	==== Saving to a file ====		==== Saving to a file ====
Line 69:		Line 81:
	watchdbg ' D ' 'PC[16]1' > trace.txt		watchdbg ' D ' 'PC[16]1' > trace.txt
	it will clobber (wipe out the contents of) the existing file and then start to output data to the file.		it will clobber (wipe out the contents of) the existing file and then start to output data to the file.

			If you want to view the output of these commands while simultaneously sending the output to a file you can use the 'tee' command:
			grepdbg connect \| tee trace.txt
			or you can use 'tee -a' to append to the file:
			grepdbg 1 gb7tlh \| tee -a trace.txt

WI3W: Saving progress...

2025-04-05T21:01:27Z

Saving progress...

← Older revision		Revision as of 21:01, 5 April 2025
Line 60:		Line 60:
	watchdbg ' I ' 'PC92'		watchdbg ' I ' 'PC92'
	Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.		Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.

	~~==== grepdbg ====~~
	~~The debug files will save these traces, and those files can then be searched using the 'grepdbg' command. Ex:~~
	~~grepdbg ' D '~~

	==== Saving to a file ====		==== Saving to a file ====

WI3W: Saving progress...

2025-04-05T21:00:15Z

Saving progress...

← Older revision		Revision as of 21:00, 5 April 2025
Line 34:		Line 34:
	</syntaxhighlight>It can also have a 'sub begin {...}' and / or 'sub end {...}' which are executed immediately after opening a logfile and then just before closing it, respectively. You can also add a 'sub total {...}' which executes after the last line is printed and grepdbg exits. Read the code of this program and copy'n'paste the 'sub process' code into a new file. Then change 'sub process' to 'sub handle'. Add the line 'package main;' at the beginning of the file and a line '1;' at the end and then modify it to your requirements...		</syntaxhighlight>It can also have a 'sub begin {...}' and / or 'sub end {...}' which are executed immediately after opening a logfile and then just before closing it, respectively. You can also add a 'sub total {...}' which executes after the last line is printed and grepdbg exits. Read the code of this program and copy'n'paste the 'sub process' code into a new file. Then change 'sub process' to 'sub handle'. Add the line 'package main;' at the beginning of the file and a line '1;' at the end and then modify it to your requirements...
	===Filtering traces===		===Filtering traces===

			Regexes can be debug levels, nodes, or even a strings of text. See Wikipedia for a basic [[wikipedia:Regular_expression\|regex]] explanation. [https://regex101.com/ Regex101] is a good place to practice.

	To trace incoming messages the I is used, and for outbound the D is used:		To trace incoming messages the I is used, and for outbound the D is used:
Line 40:		Line 42:

	'-> D' or ' D '		'-> D' or ' D '
			Protocols can be traced by using the PC number:
			'PC9[23]'
			In this example we're using '[23]' to express a range of possibilities. This results in PC92 and PC93 being hits for the filter.

			Debug levels can be traced using the level name:
			"chan\|progress"
			This regex will hit on any debug entry with the level label of "chan" or "progress".

	=== Trace examples ===		=== Trace examples ===
Line 57:		Line 66:

	==== Saving to a file ====		==== Saving to a file ====
			It is possible to save the output of these commands to a specific file by using the redirection operator " > " or " >> "in Linux. The " > " will overwrite a file and " >> " will append to a file. Both operators will create a file if it does not exist. Ex:
			watchdbg ' D ' 'PC[16]1' >> trace.txt
	~~But it~~ is possible to save the ~~traces~~ to a specific file by using ~~pipe \| to push them~~ to a file.		This command will create the file 'trace.txt' and redirect the output of the command to the file. This will need to be stopped with the key combination of Ctrl + C. If we run the same command again:
	./watchdbg ' D ' 'PC[16]1' ~~\| grep <thing to search for~~> \| trace.txt ~~----~~> ~~This still needs~~ to ~~be worked on~~.		watchdbg ' D ' 'PC[16]1' >> trace.txt
			it will append the output to the existing file, but if we run:
			watchdbg ' D ' 'PC[16]1' > trace.txt
			it will clobber (wipe out the contents of) the existing file and then start to output data to the file.

WI3W: Saving progress...

2025-04-05T19:36:08Z

Saving progress...

@@ Line 7: / Line 7: @@
 This will command will link all dbg subroutines in /spider/perl to /usr/local/bin so they can be accessed from the user prompt like any other built in command.
 ===Filtering traces===
@@ Line 15: / Line 41: @@
   '-> D' or ' D '
-====Trace examples====
+=== Trace examples ===
 To watch all outbound spots from this node:
   watchdbg ' D ' 'PC[16]1'
@@ Line 26: / Line 51: @@
   watchdbg ' I ' 'PC92'
 Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.
 ==== Saving to a file ====
-The debug files will save these traces, and those files can then be searched. But it is possible to save the traces to a specific file by using pipe | to push them to a file.
   ./watchdbg ' D ' 'PC[16]1' | grep <thing to search for> | trace.txt  ----> This still needs to be worked on.

WI3W: General editing to get ready for publish.

2025-04-05T18:29:45Z

General editing to get ready for publish.

← Older revision		Revision as of 18:29, 5 April 2025
Line 1:		Line 1:
	==General Information==		==General Information==

	~~DXspider~~ has the ability to log information at various levels, and those levels are set using the [[DXSpider Debug Commands and Levels\|debug]] tool in conjunction with the [[DXSpider Debug Commands and Levels#Levels\|debug levels]]. Whilst this information is ~~capture~~ in data files in ../spider/local_data/debug/ it can also be seen in realtime from the command line prompt. Once the debug ~~level is~~ set the watchdbg tool can be used from ../spider/perl/ to watch the cluster's full data stream. This can be a very busy stream but it can be filtered for easier scrutiny.		DXSpider has the ability to log information at various levels, and those levels are set using the [[DXSpider Debug Commands and Levels\|debug]] tool in conjunction with the [[DXSpider Debug Commands and Levels#Levels\|debug levels]]. Whilst this information is captured in the data files of ../spider/local_data/debug/ it can also be seen in realtime from the command line prompt. Once the debug levels are set the 'watchdbg' tool can be used from ../spider/perl/ to watch the cluster's full data stream. This can be a very busy stream but it can be filtered for easier scrutiny.

			This guide assumes that 'watchdbg' has been linked to /usr/local/bin. If not, you can run this command in Linux:
			sudo ln -s /spider/perl/*dbg /usr/local/bin
			This will command will link all dbg subroutines in /spider/perl to /usr/local/bin so they can be accessed from the user prompt like any other built in command.

	===Filtering traces===		===Filtering traces===
Line 9:		Line 13:
	'<- I' or ' I '		'<- I' or ' I '

	'<- D' or ' D '		'-> D' or ' D '

	====Trace examples====		====Trace examples====

	To watch all outbound spots from this node.		To watch all outbound spots from this node:
	./watchdbg ' D ' 'PC[16]1'		watchdbg ' D ' 'PC[16]1'
	or ~~just~~		or to watch everything outbound:
	./watchdbg '\-> D'		watchdbg '\-> D' or watchdbg ' D '
			The same can be done for inbound traffic:
	~~====Saving~~ to ~~a file====~~		watchdbg '<\- I' or watchdbg ' I '
			or two watch all inbound PC92 frames:
			watchdbg ' I ' 'PC92'
			Note: the hyphen needs to be escaped with the " \ " character. The spaces between ' D ' are important, make sure they are included.

			==== Saving to a file ====
	The debug files will save these traces, and those files can then be searched. But it is possible to save the traces to a specific file by using pipe \| to push them to a file.		The debug files will save these traces, and those files can then be searched. But it is possible to save the traces to a specific file by using pipe \| to push them to a file.
	./watchdbg ' D ' 'PC[16]1' \| grep <thing to search for> \| trace.txt		./watchdbg ' D ' 'PC[16]1' \| grep <thing to search for> \| trace.txt ----> This still needs to be worked on.

WI3W: Fix debug levels link

2025-04-05T17:16:40Z

Fix debug levels link

← Older revision		Revision as of 17:16, 5 April 2025
Line 1:		Line 1:
	==General Information==		==General Information==

	DXspider has the ability to log information at various levels, and those levels are set using the [[DXSpider Debug Commands and Levels\|debug]] tool in conjunction with the [~~https://wiki.dxcluster.org/wiki/DXSpider_Debug_Commands_and_Levels~~\| debug levels]. Whilst this information is capture in data files in ../spider/local_data/debug/ it can also be seen in realtime from the command line prompt. Once the debug level is set the watchdbg tool can be used from ../spider/perl/ to watch the cluster's full data stream. This can be a very busy stream but it can be filtered for easier scrutiny.		DXspider has the ability to log information at various levels, and those levels are set using the [[DXSpider Debug Commands and Levels\|debug]] tool in conjunction with the [[DXSpider Debug Commands and Levels#Levels\|debug levels]]. Whilst this information is capture in data files in ../spider/local_data/debug/ it can also be seen in realtime from the command line prompt. Once the debug level is set the watchdbg tool can be used from ../spider/perl/ to watch the cluster's full data stream. This can be a very busy stream but it can be filtered for easier scrutiny.

	===Filtering traces===		===Filtering traces===