loco

An utility to collect logs.

In the last weeks I've found myself using logrotate to organize log files of some scripts and tools... It's easy and flexible, but I find it a bit cumbersome: create a configuration file, create a cron entry... so I decided to code my own tool (mainly because I wanted to practice a bit with Go). loco capures standard out and redirect it to a file, rotating it at a specified interval.

Usage

In its simplest form you can use loco like this:

$ some-command | loco collect /path/to/log/file

loco will rotate the log file every day. If you want to use a different interval you can:

• Create a configuration for a log file. For instance, if you want the log file to be rotated every week:

  $ loco config -i 1w /path/to/log/file.log

  A custom suffix can be specified using the -s parameter:

  $ loco config -i 1w -s %Y%m%d /path/to/log/file.log

  The following values will be replaced at runtime:

  • %%: literal %
  • %c: number of times the file has been rotated
  • %Y: year (four digits)
  • %m: month (01 to 12)
  • %d: day (01 to 31)
  • %H: hour (00 to 23)
  • %M: minute (00 to 59)
  • %S: second (00 to 59)

  Default value is %c

• Change the defaults; if you want to set all the log files rotate, by default, every 3 days using a timestamp suffix:

  $ loco defaults -i 3d -s %Y%m%d%H%M%S

• Set the LOCO_INTERVAL environment variable to a valid interval

• Set the LOCO_SUFFIX environment variable to a suffix

Valid intervals

Valid intervals have the form \d+[mhdwM]

• m stands for minute
• h stands for hour
• d stands for days
• w stands for weeks
• M stands for months

Configurations

To create or edit configurations:

$ loco config -i <interval> /path/to/file.log

To list active configurations:

$ loco list

To remove a configuration (not the log files):

$ loco remove /path/to/file.log

Defaults

To show the defaults:

$ loco defaults

To set defaults:

$ loco defaults -i <interval>

Collecting logs

$ loco collect /path/to/file.log

The -t or --tee makes loco work as the tee command: output is send to both log file and stdout.

Autocompletion

loco uses the excellent kingpin library to parse command line and options. In order to have command completion you can add:

eval "$(loco --completion-script-bash)"

to your .bashrc file or

eval "$(loco --completion-script-zsh)"

to .zshrc.

TODO

• Custom suffix
• Save rotate history in state?
• Max rotations
• Clone configurations
• Autocompletion hints
• Post rotate actions:
  • Gzip
  • Move/copy to another directory
  • Move/copy to a remote destination (S3 bucket, ...)