Changeset fc40813fa71d42020ea58cec1980a68e899b182d in xas-logmon


Ignore:
Timestamp:
12/22/15 14:08:52 (3 years ago)
Author:
Kevin L. Esteb <kevin@…>
Branches:
master
Children:
4e013ac79b13b19b0ee17a381d9f5236b3051088
Parents:
9fe8156b53dfebd170ae701a7f8f0d6d483392bb
git-author:
Kevin L. Esteb <kevin@…> (12/22/15 14:08:52)
git-committer:
Kevin L. Esteb <kevin@…> (12/22/15 14:08:52)
Message:

updating documentation

Location:
trunk/sbin
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/sbin/xas-logmon

    r71b41918e7074bbc7a6c4c165197e3709e7a086b rfc40813fa71d42020ea58cec1980a68e899b182d  
    5252=head1 NAME 
    5353 
    54 xas-logmon - the control program for log monitors 
     54xas-logmon - the control program for file monitors 
    5555 
    5656=head1 SYNOPSIS 
     
    7777=head1 CONFIGURATION 
    7878 
    79 The configuration file uses the familiar Windows .ini format. It has the  
    80 following stanza. 
    81  
    82  [logmon: xas-spooler] 
    83  command = /usr/sbin/xas-logs 
    84  filename = /var/log/xas/xas-spooler.log 
    85  user = xas 
    86  group = xas 
    87  
    88 Where the section header "logmon:" may have addtional qualifiers and repeated 
    89 as many times as needed. The following properties may be used. 
    90  
    91 =over 4 
    92  
    93 =item B<ignore> 
    94  
    95 Ignore anything before this number of days. Defaults to 30 days. 
    96  
    97 =item B<filename> 
    98  
    99 The name of the file to monitor. Defaults to /var/log/xas/xas-spooler.log 
    100  
    101 =item B<spooldir> 
    102  
    103 The name of the spool directory to write the parsed lines too. Defaults to 
    104 /var/spool/xas/logs 
    105  
    106 =item B<command> 
    107  
    108 The command to spawn. This command needs to understand the following command 
    109 line: 
    110  
    111  --filename %s --spooldir %s --ignore %s --log-type console 
    112  
    113 Where %s is subsituted with the appropiate values. 
    114  
    115 =item B<auto-start> 
    116  
    117 Wither to auto start the process. Defaults to true. 
    118  
    119 =item B<auto-restart> 
    120  
    121 Wither to restart the process should it die. Defaults to true. 
    122  
    123 =item B<directory> 
    124  
    125 The root directory to for the command to run in. Defaults to "/". 
    126  
    127 =item B<exit-codes> 
    128  
    129 Auto restart only works if the process uses these exit codes. Defaults to "0,1". 
    130 This needs to be a comma delimited string. 
    131  
    132 =item B<exit-retries> 
    133  
    134 The number of retries to try before giving up. Defaults to -1. This means to  
    135 continually retry. 
    136  
    137 =item B<group> 
    138  
    139 The group to run the process under. Defaults to "xas". This is not used on 
    140 Windows platforms. 
    141  
    142 =item B<priority> 
    143  
    144 The priority to run the process under. Defaults to 0. This is not used on 
    145 Windows platforms. 
    146  
    147 =item B<umask> 
    148  
    149 The umask for the process. Defaults to "0022". This is not used on Windows 
    150 platforms. 
    151  
    152 =item B<user> 
    153  
    154 The user to run the process under. This defaults to "xas". This is not used 
    155 on Windows platforms. 
    156  
    157 =back 
     79Please refer to L<XAS::Apps::Logmon::Monitor|XAS::Apps::Logmon::Monitor> 
     80for configuration file information. 
    15881 
    15982=head1 OPTIONS AND ARGUMENTS 
  • trunk/sbin/xas-logs

    r8496bdb0739806df787c8be0b3c66756ab4a6efa rfc40813fa71d42020ea58cec1980a68e899b182d  
    6060 
    6161 options: 
     62   --filename     name of log file to monitor 
     63   --spooldir     the directory tp write the messages too 
     64   --ignore       ignore log entries older then these days 
     65   --process      name of process that created file 
    6266   --help         outputs simple help text 
    6367   --manual       outputs the procedures manual 
     
    6872   --log-type     toggles the log type 
    6973   --log-facility changes the log facility 
    70    --filename     name of log file to monitor 
    71    --spooldir     the directory tp write the messages too 
    72    --ignore       ignore log entries older then these days 
    7374 
    7475=head1 DESCRIPTION 
     
    9394 
    9495Ignore any log lines older then these days. 
     96 
     97=item B<--process> 
     98 
     99That name of the process that create the file. 
    95100 
    96101=item B<--help> 
Note: See TracChangeset for help on using the changeset viewer.