Logrotate in Yate

Revision as of 23:29, 12 March 2014

logrotate is a UNIX program that eases the management of log files by automatically compressing, rotating, removing and emailing the files as specified in the configuration files. It runs as a daily cron job. Yate doesn't rotate its own logs, but integrates into "logrotate" by providing a configuration file for it.

logrotate and Yate

If you decide that you want to take a look, you can find the logrotate configuration as "yate.logrotate" in the packing/ subdirectory in the Yate source. When you install Yate as a service, this file will be installed as /etc/logrotate.d/yate/, along with the configuration files for all the other services and programs installed on your system.

Type “man logrotate” in the command line for an explanation of logrotate options and configuration file syntax.

Prepare logs rotation

Copy packing/yate.logrotate as /etc/logrotate.d/yate and optionally edit it to adjust the limits. Note that logrotate normally runs daily so make sure you collect signifficantly less than 2GB of logs in 24 hours.

You will also need to make the file owned by root:

cp packing/yate.logrotate /etc/logrotate.d/yate
chown root.root /etc/logrotate.d/yate

If your logs grow too fast you have to either reduce the logging level - eventually per module - or set up logrotate to run more often. For example you can move the logrotate script from /etc/cron.daily to /etc/cron.hourly

How does it work?

The logrotate configuration file, etc/logrotate.conf, besides the usual options and directives, includes other configuration files found in /etc/logrotate.d. Various packages will install their own configuration file that ensures their logs are properly rotated. This also applies for yate.logrotate, which will rotate yate's log file.

Below you can see the content of the configuration file:

Content of /etc/logrotate.d/yate

# Have to rotate the log and CDR files before each reaches 2GB in size

/var/log/yate /var/log/yate-cdr.tsv {
    size=100M
    rotate 5
    missingok
    sharedscripts
    notifempty
    postrotate
    /bin/kill -HUP `/bin/cat /var/run/yate.pid`
    endscript
}

According to this configuration file, logrotate handles the files yate and yate-cdr.tsv by rotating it each time its size reaches 100 M.
Each day, logrotate will compare the size of /var/log/yate with 100 M. If its size is 100 M or bigger, the log file will be rotated.
The number of rotations is 5.
After a running period of time, logrotate will start overwriting the rotated files. This measure is meant to prevent Yate's crash due to /var/log/yate reaching a file size of 2 GB.
You won't receive an error message if the log file is missing but the file will not be rotated if it is empty.
The command “kill -HUP” sends a SIGHUP signal to Yate's supervisor each time yate.logrotate has finished rotating the log file.

Prepare the init script

You need to copy and rename the proper yate.init from a subdirectory of packing/ to /etc/init.d where all service start scripts are installed. Note that the script and additional tools depend on the Linux distribution used so take the correct one.

This operation needs that you run as root:

cp packing/rpm/yate.init /etc/init.d/yate
chown root.root /etc/init.d/yate

Replace rpm with what matches best your distribution's package manager.

You will then need to edit the init file and change the path to the executable from /usr/bin to /usr/local/bin

You may also alter the command line options to get more debugging. Is is recommended to enable timestamping the log messages.

How to use it?

To use yate.logrotate, you must enable the rotate option when you start Yate as a service.
The -r option requires enabling the supervised mode and naming a log file. So run Yate including -s -r -l to the command “yate”.
When running yate as a service with rotation enabled, you will find the log files in /var/log/yate. Otherwise, the log files are found in the build directory. For more information related to Yate's start command, type yate --help.

See also

• Starting Yate