---
name: "Log::Dispatch::FileWriteRotate"
section: "3pm"
platform: "linux"
package: "liblog-dispatch-filewriterotate-perl"
version: "0.062-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Log::Dispatch::FileWriteRotate"
---

# Log::Dispatch::FileWriteRotate(3pm)

Log to files that archive/rotate themselves, w/ File::Write::Rotate

## NAME

Log::Dispatch::FileWriteRotate - Log to files that archive/rotate themselves, w/ File::Write::Rotate

## VERSION

This document describes version 0.062 of Log::Dispatch::FileWriteRotate (from Perl distribution Log-Dispatch-FileWriteRotate), released on 2021-07-21.

## SYNOPSIS

```
 use Log::Dispatch::FileWriteRotate;
 my $file = Log::Dispatch::FileWriteRotate(
     min_level => 'info',
     # will be passed to File::Write::Rotate
     dir       => '/var/log',
     prefix    => 'myapp',
     suffix    => '.log',
     period    => 'monthly',
     size      => 25*1024*1024,
     histories => 12,
 );
 $file->log(level => 'info', message => "Your comment\n");
```

## DESCRIPTION

This module functions similarly to Log::Dispatch::FileRotate, but uses File::Write::Rotate as backend, thus interoperates more easily with other modules which use File::Write::Rotate as backend, e.g. Tie::Handle::FileWriteRotate or Process::Govern.

## CONTRIBUTOR

Steven Haryanto \<sharyanto@cpan.org\>

## METHODS

### new(%args)

Constructor. This method takes a hash of parameters. The following options are valid: `"min_level"` and `"max_level"` (see Log::Dispatch documentation); `"dir"`, `"prefix"`, `"suffix"`, `"period"`, `"size"`, and `"histories"` (see File::Write::Rotate).

### log\_message(message =\> STR)

Send a message to the appropriate output. Generally this shouldn't be called directly but should be called through the `"log()"` method (in LLog::Dispatch::Output\>).

### fwr

Expose File::Write::Rotate object. You can do access this object e.g. to compress logfiles:

```
 $file->fwd->compress;
```

## HOMEPAGE

Please visit the project's homepage at \<https://metacpan.org/release/Log-Dispatch-FileWriteRotate\>.

## SOURCE

Source repository is at \<https://github.com/perlancar/perl-Log-Dispatch-FileWriteRotate\>.

## BUGS

Please report any bugs or feature requests on the bugtracker website \<https://rt.cpan.org/Public/Dist/Display.html?Name=Log-Dispatch-FileWriteRotate\>

When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.

## SEE ALSO

Log::Dispatch

File::Write::Rotate

Log::Dispatch::FileRotate

## AUTHOR

perlancar \<perlancar@cpan.org\>

## COPYRIGHT AND LICENSE

This software is copyright (c) 2021, 2019, 2015, 2013, 2012 by perlancar@cpan.org.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
