diff options
author | Sergey Poznyakoff <gray@gnu.org> | 2019-07-22 14:53:37 +0300 |
---|---|---|
committer | Sergey Poznyakoff <gray@gnu.org> | 2019-07-22 14:53:37 +0300 |
commit | b369ed6ad26c07d3aec65a1bf0910c0d828c400f (patch) | |
tree | 525b13a5bbda244cbec3fe10c25c47aa2975e2a5 /doc/wydawca.texi | |
parent | 0917d1276103d9cc893e8ac091e9e63c5e6182f8 (diff) | |
download | wydawca-b369ed6ad26c07d3aec65a1bf0910c0d828c400f.tar.gz wydawca-b369ed6ad26c07d3aec65a1bf0910c0d828c400f.tar.bz2 |
Finish mod_logstat implementation. Document it.
* doc/wydawca.texi: Document mod_logstat.
* include/wydawca/wydawca.h (wy_ev_statistics): Rename to
wy_ev_finish. All uses changed.
(wydawca_stat): New enum (from src/wydawca.h)
(WY_STAT_MASK,WY_STAT_MASK_NONE)
(WY_STAT_MASK_ALL): New macros.
All uses changed.
* modules/logstat/mod_logstat.c (stat_mask): Default to WY_STAT_MASK_ALL.
(wy_notify): Provide default output.
Diffstat (limited to 'doc/wydawca.texi')
-rw-r--r-- | doc/wydawca.texi | 93 |
1 files changed, 88 insertions, 5 deletions
diff --git a/doc/wydawca.texi b/doc/wydawca.texi index db06139..1f76e71 100644 --- a/doc/wydawca.texi +++ b/doc/wydawca.texi @@ -2409,7 +2409,14 @@ uploader. @kwindex check-failure @item check-failure Distribution verification failed. @xref{verification}, for a -detailed description. +detailed description. + +@kwindex finish +@item finish + This event is reported at the end of the wydawca job, when all +spools have been processed. It is normally used to produce final +statistic reports. @xref{statreports}, for an example. +See also @ref{mod_logstat}. @end table @end deffn @@ -2650,6 +2657,16 @@ mail-statistics @{ gpg-sign @var{key}; @} @end smallexample + +To arrange for sending the reports, the configuration must contain the +following statement: + +@smallexample +notify-event @{ + event finish; + module mailutils; +@} +@end smallexample @end deffn @deffn {mail-statistics} message text-or-id @@ -2690,6 +2707,7 @@ The statistics message is sent to addresses configured by @cindex meta-variables in admin notifications The meta-variables available for use in statistics reports are: +@anchor{statistics variables} @multitable @columnfractions 0.30 0.70 @headitem Variable @tab Replaced with @kwindex date @@ -3044,6 +3062,11 @@ module-init mailutils @{ @} notify-event @{ + event finish; + module mailutils; +@} + +notify-event @{ event success; module mailutils; module-config @{ @@ -3068,13 +3091,73 @@ notify-event @{ @} @end example -For the sake of brevity, this example defines only one -@code{notify-event} statement. More statements for others events can +For the sake of brevity, this example defines only two +@code{notify-event} statements. More statements for others events can be added as needed. @node mod_logstat -@subsection Notification to syslog -@UNREVISED +@subsection @command{mod_logstat} -- statistics logging + +The module @command{mod_logstat} logs the supplied message text at the +end of the run. + +The simplest configuration for this module is: + +@smallexample +@group +module logstat mod_logstat.so; + +notify-event @{ + event finish; + module logstat; +@} +@end group +@end smallexample + +This will produce on the default logging channel the detailed +statistics, as discussed in @ref{statistics}. + +There is no specific @code{module-init} statements. The module should +be called from @code{notify-event} block on the @samp{finish} event. +The module's @code{module-config} statement can contain the following +statements: + +@deffn {mod_logstat config} statistics list +Configures what statistics items should be included in the output. +@xref{statistics}, for a detailed discussion of @var{list}. + +This statement is ignored if the @code{message} statement is present. +@end deffn + +@deffn {mod_logstat config} message text +Specifies the message to be logged. The @var{text} argument can +contain references to statistics variables (@pxref{statistics +variables}). +@end deffn + +If no @code{message} statement is present, the following default is +assumed: + +@example +@group +message <<EOT +errors: $@{stat:errors@} +warnings: $@{stat:warnings@} +bad signatures: $@{stat:bad_signatures@} +access violation attempts: $@{stat:access_violations@} +complete triplets: $@{stat:complete_triplets@} +incomplete triplets: $@{stat:incomplete_triplets@} +bad triplets: $@{stat:bad_triplets@} +expired triplets: $@{stat:expired_triplets@} +triplet successes: $@{stat:triplet_success@} +files uploaded: $@{stat:uploads@} +files archived: $@{stat:archives@} +symlinks created: $@{stat:symlinks@} +symlinks removed: $@{stat:rmsymlinks@} +check failures: $@{stat:check-failures@} +EOT; +@end group +@end example @node wydawca.rc @chapter @command{Wydawca} configuration file. |