NAME

WebJobLogRoller - Compress and archive WebJob log files

SYNOPSIS

webjob-log-roller [-l] [-c {bzip2|compress|gzip|none}] [-G archive-gid] [-g log-gid] [-h hook-command] [-M archive-mode] [-m log-mode] [-U archive-uid] -d log-dir -u log-uid

DESCRIPTION

WebJobLogRoller is a sh(1) script that can be run manually or periodically from cron(1). The purpose of this script is to compress and archive WebJob log files.

OPTIONS

-c {bzip2|compress|gzip|none}

This option specifies the compression method to use. The default value is 'gzip'.

-d log-dir

This option specifies the directory that contains WebJob log files. This argument is required.

-G archive-gid

This option specifies the group ID to assign to each archived log file. The default value is '0'.

-g log-gid

This option specifies the group ID to assign to each newly created log file. The default value is '0'.

-h hook-command

This option specifies the name of a custom (perhaps site-specific) utility that can be used to operate on each log file before it is compressed. This utility will be invoked as follows:

    <utility> -f <log-file>

To be considered successful, the utility must return an exit code of zero.

-l

List the log files that will be rolled for the specified log directory and exit.

-M archive-mode

This option specifies the file permissions to assign to each archived log file. The default value is '0640'.

-m log-mode

This option specifies the file permissions to assign to each newly created log file. The default value is '0640'.

-U archive-uid

This option specifies the user ID to assign to each archived log file. The default value is '0'.

-u log-uid

This option specifies the user ID to assign to each newly created log file. This argument is required, and its value should be the username or user ID of the Apache server daemon. Typical usernames associated with this daemon include: 'apache', 'nobody', and 'www'.

RETURN VALUES

Upon successful completion, a value of 0 (XER_OK) is returned. Otherwise, one of the following error codes is returned:

• 1 = XER_Usage

• 2 = XER_Bootstrap

• 3 = XER_ProcessArguments

• 4 = XER_DoLogRoll

SEE ALSO

nph-config.cgi(1), nph-webjob.cgi(1), webjob(1)

AUTHOR

Klayton Monroe

HISTORY

This utility was initially written to support WebJob deployments.

LICENSE

All documentation and code are distributed under same terms and conditions as WebJob.