mirror of
				https://github.com/coredns/coredns.git
				synced 2025-11-03 18:53:13 -05:00 
			
		
		
		
	each readme starts with the plugin's name as a header, this needs to be chopped off to provide a good manual page. Signed-off-by: Miek Gieben <miek@miek.nl>
		
			
				
	
	
		
			70 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
			
		
		
	
	
			70 lines
		
	
	
		
			1.5 KiB
		
	
	
	
		
			Groff
		
	
	
	
	
	
.\" Generated by Mmark Markdown Processer - mmark.nl
 | 
						|
.TH "COREDNS-DEBUG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
 | 
						|
 | 
						|
.SH NAME
 | 
						|
.PP
 | 
						|
\fIdebug\fP - disables the automatic recovery upon a crash so that you'll get a nice stack trace.
 | 
						|
 | 
						|
.SH DESCRIPTION
 | 
						|
.PP
 | 
						|
Normally CoreDNS will recover from panics, using \fIdebug\fP inhibits this. The main use of \fIdebug\fP is
 | 
						|
to help testing. A side effect of using \fIdebug\fP is that \fB\fClog.Debug\fR and \fB\fClog.Debugf\fR will be printed
 | 
						|
to standard output.
 | 
						|
 | 
						|
.PP
 | 
						|
Note that the \fIerrors\fP plugin (if loaded) will also set a \fB\fCrecover\fR negating this setting.
 | 
						|
 | 
						|
.SH SYNTAX
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
debug
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.PP
 | 
						|
Some plugin will debug log DNS messages. This is done in the following format:
 | 
						|
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
debug: 000000 00 0a 01 00 00 01 00 00 00 00 00 01 07 65 78 61
 | 
						|
debug: 000010 6d 70 6c 65 05 6c 6f 63 61 6c 00 00 01 00 01 00
 | 
						|
debug: 000020 00 29 10 00 00 00 80 00 00 00
 | 
						|
debug: 00002a
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.PP
 | 
						|
Using \fB\fCtext2pcap\fR (part of Wireshark) this can be converted back to binary, with the following
 | 
						|
command line: \fB\fCtext2pcap -i 17 -u 53,53\fR. Where 17 is the protocol (UDP) and 53 are the ports. These
 | 
						|
ports allow wireshark to detect these packets as DNS messages.
 | 
						|
 | 
						|
.PP
 | 
						|
Each plugin can decide to dump messages to aid in debugging.
 | 
						|
 | 
						|
.SH EXAMPLES
 | 
						|
.PP
 | 
						|
Disable the ability to recover from crashes and show debug logging:
 | 
						|
 | 
						|
.PP
 | 
						|
.RS
 | 
						|
 | 
						|
.nf
 | 
						|
\&. {
 | 
						|
    debug
 | 
						|
}
 | 
						|
 | 
						|
.fi
 | 
						|
.RE
 | 
						|
 | 
						|
.SH ALSO SEE
 | 
						|
.PP
 | 
						|
https://www.wireshark.org/docs/man-pages/text2pcap.html
 | 
						|
\[la]https://www.wireshark.org/docs/man-pages/text2pcap.html\[ra].
 | 
						|
 |