The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.

NAME

Dancer::Logger::Hourlyfile - Rotate writing to log files on an hourly basis

DESCRIPTION

This module will write log entries to a separate file every hour. It will append YYYYMMDDHH to each hourly logfile name. Specify local time or GMT time. Finally, you use the "extended" filename setting to further breakdown by writing into subdirectories YYYY/MM/DD/

  filename:

      log/2014052019_filename.log
      ^^^ ^^^^^^^^^^ ^^^^^^^^
      |   YYYYMMDDHH Filename 
      Path

              
  extended:

      log/2014/05/20/2014052019_filename.log
      |              ^^^^^^^^^^ ^^^^^^^^
      Path           YYYYMMDDHH Filename 

CONFIGURATION SETTINGS

In your Dancer's environment file set the following:

  logger:     "hourlyfile"   # tell Dancer to use this module
  log_path:   "/var/log"     # full path
  log_hourly: "filename"     # defaults to "filename" if not specified.
                             # The only other option is "extended"
  log_file:   "outputfile"   # file name
  log_time:   "local"        # defaults to "local" if not specified.  
                               The only other option is "gmt" 

SAMPLE CONFIGURATION

filename(default)

    logger:     "hourlyfile"
    log:        "core"
    log_path:   "/var/mydancerapp/logs"
    log_file:   "myserver"
    log_time:   "gmt"
    log_hourly: "filename"

  This configuration will produce the following files where the times are GMT:

    /var/mydancerapp/logs/2014052000_myserver.log
    /var/mydancerapp/logs/2014052001_myserver.log
    ...
    ...
    ...
    /var/mydancerapp/logs/2014052023_myserver.log

Extended

    logger:     "hourlyfile"
    log:        "core"
    log_path:   "/var/mydancerapp/logs"
    log_file:   "myserver"
    log_time:   "gmt"
    log_hourly: "extended"

  This configuration will produce the following files where the times are GMT:

    /var/mydancerapp/logs/2014/05/20/2014052000_myserver.log
    /var/mydancerapp/logs/2014/05/20/2014052001_myserver.log
    ...
    ...
    ...
    /var/mydancerapp/logs/2014/05/20/2014052023_myserver.log

AUTHOR

Hagop "Jack" Bilemjian, <jck000 at gmail.com>

BUGS

Please report any bugs or feature requests to bug-dancer-logger-rotatehourly at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dancer-Logger-Hourlyfile. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Dancer::Logger::Hourlyfile

You can also look for information at:

ACKNOWLEDGEMENTS

Dancer!

LICENSE AND COPYRIGHT

Copyright 2014 Hagop "Jack" Bilemjian.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

2 POD Errors

The following errors were encountered while parsing the POD:

Around line 152:

You forgot a '=back' before '=head2'

Around line 235:

You forgot a '=back' before '=head1'