epylog-modules(5)

1epylog-modules(5)             Applications/System            epylog-modules(5)
2
3
4

NAME

6       epylog-modules - epylog module cofiguration.
7
8

SYNOPSIS

10       epylog  uses pluggable modules to perform analysis and report on syslog
11       strings. This manpage explains the format of the module config files.
12
13

modules.d

15       Epylog config files are placed in the modules.d directory of the cfgdir
16       specified in epylog.conf. Any file ending in .conf in that directory is
17       considered a module config file. Most  common  location  for  modules.d
18       directory is in /etc/epylog/modules.d.
19
20

module.conf

22       The name of the config file doesn't carry much meaning, however it MUST
23       end in .conf in order to be recognized as a module config file.
24
25       The config file for each module is separated into two  parts:  [module]
26       and [conf].
27
28

[module]

30       desc   The  description  of  the  module. It will be shown in the final
31              report.
32
33       exec   This is where the "body" of the module is located. Most  modules
34              that   come   with   the   distribution   will   be   placed  in
35              /usr/share/epylog/modules, but depending on your setup, you  may
36              place them elsewhere.
37
38       files  List  the logfiles requested by this module in this field. Sepa‐
39              rate multiple entries  by  comma.  Epylog  will  handle  rotated
40              files,  but you need to specify the mask appropriately. E.g. the
41              most common logrotate setup will place rotated files in the same
42              directory and add .0, .1, like so:
43              /var/log/filename[.#]
44              If you have compression turned on, your entry will look like so:
45              /var/log/filename[.#.gz]
46              Lastly, for advanced configurations, more complex entries may be
47              required. E.g. if your logrotate saves rotated files in a subdi‐
48              rectory in /var/log, you can specify it like so:
49              /var/log/[rotate/]filename[.#.gz]
50              This will work, too:
51              /var/log/filename[/var/rotate/filename.#.gz]
52              In any case, "#" will be where the increments will go.
53
54       enabled
55              Can  be  either "yes" or "no". If "no" is specified, Epylog will
56              completely ignore this module.
57
58       internal
59              Can be either "yes" or "no". If "yes", then the module  is  han‐
60              dled  as an internal module, and if "no", then the external mod‐
61              ule API is used. See doc/modules.txt for more information  about
62              the module APIs.
63
64       outhtml
65              Specifies  whether  the output produced by the module is HTML or
66              not. Can be either "yes" or "no".
67
68       priority
69              An unsigned int. Most commonly a number from 0  to  10.  Modules
70              with  the  lowest number will be considered the highest prioroty
71              and will be both invoked  and  presented  in  the  final  report
72              before the others.
73
74

[conf]

76       This is where per-module configuration directives go. Some modules have
77       these, some don't. Look in the module config file -- the available val‐
78       ues should be listed and described there.
79
80

COMMENTS

82       Lines starting with "#" will be considered commented out.
83
84

AUTHORS

86       Konstantin Ryabitsev <icon@linux.duke.edu>
87
88