LR_VENDOR_CRON.IN(1)

NAME
lr_vendor_cron - generate Lire reports from all known log files on the system

SYNOPSIS
lr_vendor_cron daily|weekly|monthly

DESCRIPTION
lr_vendor_cron is designed to be invoked by cron. On systems supporting /etc/cron.d/, this script can be invoked by creating /etc/cron.d/lire, which should read e.g.:

 02 5 * * * root /usr/sbin/lr_vendor_cron daily
 22 5 * * 0 root /usr/sbin/lr_vendor_cron weekly
 42 5 1 * * root /usr/sbin/lr_vendor_cron monthly

lr_vendor_cron reads files /etc/sysconfig/lire.d/*.cfg and /etc/default/lire.d/*.cfg. For each log file, such a file should exist. The files should set the following shell variables:

daemon
    the name of a binary which generated the specific log. This is used to test wether the *.cfg-file is suitable for the current system. If you'd like to generate a log for which no daemon is present on the current system, just use a placeholder like "daemon=/bin/true".

service
    a Lire service, e.g. sendmail,

logfile
    e.g. /var/log/mail.log.1.gz,

filter
    e.g. 'gzip -dc' or 'zcat | grep sendmail', and

rotateperiod
    one of the supported lr_vendor_cron arguments.

extraopts
    optional: extra options passed to lr_log2mail(1). Set this to e.g. '--template www_local'.

After parsing the configuration files, lr_vendor_cron invokes lr_log2mail(1) on the `filter'ed log file. Reading and filtering the log is done as root, lr_log2mail is run as user lire, using su(1). Output is fed to logger(1).

SECURITY
lr_vendor_cron is supposed to be run as root. However, please note that this script is distributed WITHOUT ANY WARRANTY. If you don't like to run such a script as root, make sure your lire user has read access to all log files you'd like to get processed, and adapt this script. We supply this script mainly for people building packages. On many Unix and GNU/Linux distributions, it's hard to enforce log file readability by the lire user. This script is mainly a way to work around this.

ENVIRONMENT VARIABLES
lr_vendor_cron honours DEBUG, CONFDIR, PRIORITY (for logger(1) call), and LIREUSER. Beware! PRIORITY as used here is independent of the LR_FACILITY as set in /etc/lire/defaults. This script does not use any of the settings in /etc/lire/defaults.

VERSION
$Id: lr_vendor_cron.in,v 1.14 2006/07/23 13:16:33 vanbaal Exp $

COPYRIGHT
Copyright (C) 2002, 2003 Stichting LogReport Foundation LogReport@LogReport.org Copyright (C) 2005 Joost van Baal

This program is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html.

AUTHORS
Francis J. Lacoste <flacoste@logreport.org>, Joost van Baal <joostvb@logreport.org>