mirror of
https://github.com/coredns/coredns.git
synced 2026-04-07 04:25:32 -04:00
chore(docs): regenerate man pages (#7971)
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
|
||||
.TH "COREDNS-ERRORS" 7 "March 2021" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-ERRORS" 7 "March 2026" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH "NAME"
|
||||
.PP
|
||||
@@ -33,14 +33,19 @@ Extra knobs are available with an expanded syntax:
|
||||
|
||||
.nf
|
||||
errors {
|
||||
consolidate DURATION REGEXP
|
||||
stacktrace
|
||||
consolidate DURATION REGEXP [LEVEL] [show\_first]
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Option \fB\fCconsolidate\fR allows collecting several error messages matching the regular expression \fBREGEXP\fP during \fBDURATION\fP. After the \fBDURATION\fP since receiving the first such message, the consolidated message will be printed to standard output, e.g.
|
||||
Option \fB\fCstacktrace\fR will log a stacktrace during panic recovery.
|
||||
|
||||
.PP
|
||||
Option \fB\fCconsolidate\fR allows collecting several error messages matching the regular expression \fBREGEXP\fP during \fBDURATION\fP. \fBREGEXP\fP must not exceed 10000 characters. After the \fBDURATION\fP since receiving the first such message, the consolidated message will be printed to standard output with
|
||||
log level, which is configurable by optional option \fBLEVEL\fP. Supported options for \fBLEVEL\fP option are \fB\fCwarning\fR,\fB\fCerror\fR,\fB\fCinfo\fR and \fB\fCdebug\fR.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
@@ -51,6 +56,36 @@ Option \fB\fCconsolidate\fR allows collecting several error messages matching th
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
If the optional \fB\fCshow_first\fR flag is specified, the first error will be logged immediately when it occurs, and then subsequent matching errors will be consolidated. When the consolidation period ends:
|
||||
- If only one error occurred, no summary is printed (since it was already logged)
|
||||
- If multiple errors occurred, a summary is printed showing the total count
|
||||
|
||||
.PP
|
||||
Example with 3 errors:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
[WARNING] 2 example.org. A: read udp 10.0.0.1:53\->8.8.8.8:53: i/o timeout
|
||||
[WARNING] 3 errors like '^read udp .* i/o timeout$' occurred in last 30s
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Example with 1 error:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
[WARNING] 2 example.org. A: read udp 10.0.0.1:53\->8.8.8.8:53: i/o timeout
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Multiple \fB\fCconsolidate\fR options with different \fBDURATION\fP and \fBREGEXP\fP are allowed. In case if some error message corresponds to several defined regular expressions the message will be associated with the first appropriate \fBREGEXP\fP.
|
||||
|
||||
@@ -74,7 +109,9 @@ example.org {
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Use the \fIforward\fP to resolve queries via 8.8.8.8 and print consolidated error messages for errors with suffix " i/o timeout" or with prefix "Failed to ".
|
||||
Use the \fIforward\fP plugin to resolve queries via 8.8.8.8 and print consolidated messages
|
||||
for errors with suffix " i/o timeout" as warnings,
|
||||
and errors with prefix "Failed to " as errors.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
@@ -83,7 +120,7 @@ Use the \fIforward\fP to resolve queries via 8.8.8.8 and print consolidated erro
|
||||
\&. {
|
||||
forward . 8.8.8.8
|
||||
errors {
|
||||
consolidate 5m ".* i/o timeout$"
|
||||
consolidate 5m ".* i/o timeout$" warning
|
||||
consolidate 30s "^Failed to .+"
|
||||
}
|
||||
}
|
||||
@@ -91,3 +128,22 @@ Use the \fIforward\fP to resolve queries via 8.8.8.8 and print consolidated erro
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Use the \fIforward\fP plugin and consolidate timeout errors with \fB\fCshow_first\fR option to see both
|
||||
the summary and the first occurrence of the error:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
forward . 8.8.8.8
|
||||
errors {
|
||||
consolidate 5m ".* i/o timeout$" warning show\_first
|
||||
consolidate 30s "^Failed to .+" error show\_first
|
||||
}
|
||||
}
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
|
||||
Reference in New Issue
Block a user