NAME

C<Log::Dispatch::File> - destination end point for logging into a text file


DESCRIPTION

This log destination sends lines of log into a text file. The lines are formatted using standard means of
L<C<Log::Dispatch::Msg>|Msg.md>.


If the destination file doesn't exists it will be created.


This destination can operate in two modes: streaming or discrete. In the streaming mode the log file is opened on start
and closed when the dispatcher shuts down. In the discrete mode the log file is opened and closed on per-message basis.
The latter is recommended for daemons for which it is undesirable to stop them to perform log rotation as moving away
the old log file before archiving is all the rotator tool has to do.


ATTRIBUTES

head

A flag requesting the destination to operate in safe mode, i.e. with no write buffers. Defaults to I<False>.


The flag which turns on the discrete mode of operation. Defaults to I<False>.


METHODS

L<C<Log::Dispatch>|../Dispatch.md>,
L<C<Log::Dispatch::Source>|Source.md>,
L<C<Log::Dispatch::Destination>|Destination.md>,
L<C<Log::Dispatch::Msg>|Msg.md>


AUTHOR

root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


React

=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

File

C<Log::Dispatch::Msg> - log message class


This class represents a data structure holding information about a log entry.


L<C<Instant>|https://docs.raku.org/type/Instant>C<:D $.timestamp>


The moment when message object has been produced


Message level provided with L<C<Log::Dispatch::Source>|Source.md> C<log> method call. Defaults to C<INFO>.


If defined then hold the source name, as in L<C<Log::Dispatch::Source>|Source.md> C<$.name> attribute.


The log message, as provided with L<C<Log::Dispatch::Source>|Source.md> C<log> method call. The list is maintained unmodified,
i.e. it represents the positional arguments of the call. For example, a call like:


code

["Count: ", 42, " for object ", <instance of Foo>]


Returns a formatted representation of message level which is just the level name left-padded with spaces to match the
longest level name length of 9 symbols.


Returns formatted timestamp in form of a string I<YYYY-MM-DD HH:MM::SS>.


Returns a sequence of lines representing the message object in the default log format which consists of:


<date-time> [<padded level>] [<source name if present>] <a message line>


Date-time and level strings produced by C<fmt-timestamp> and C<fmt-level> methods correspondingly.


item

In other words, if the log message consisted of something like:


The the method would produce a sequence of three lines:


1970-01-31 01:02:03 [     INFO] Line 1
1970-01-31 01:02:03 [     INFO] 42
1970-01-31 01:02:03 [     INFO] Line 3


So, if one has a multi-line output to be logged they must not be worried about it and can just submit it into the
dispatcher as-is.


L<C<Log::Dispatch>|../Dispatch.md>, L<C<Log::Dispatch::Source>|Source.md>, L<C<Log::Dispatch::Destination>|Destination.md>


C<Log::Dispatch::Destination> - role implementing destination end-point interface


This role must be consumed by any class, implementing log destination.


Defines the maximum log level this destination would record. Any message with a level higher than this gets dropped.


C<method report(>L<C<Log::Dispatch::Msg>|Msg.md>C<:D $msg)>


The only method to be implemented by a destination end-point class. Must take the C<$msg> object and translate it into
a format, acceptable by the destination. Normally it would be as simple, as producing one or few lines using the helper
method C<fmt-lines>, provided by L<C<Log::Dispatch::Msg>|Msg.md> class. But a destination more complicated may require more
complicated data structure to be submitted.


Don't override unless there is a B<really> good reason.


L<C<Log::Dispatch>|../Dispatch.md>, L<C<Log::Dispatch::Source>|Source.md>, L<C<Log::Dispatch::Msg>|Msg.md>


Destination

The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


File

NAME

ATTRIBUTES

`IO:D() $.file`

`Bool:D $.safe`

`Bool:D $.discrete`

METHODS

SEE ALSO

AUTHOR

Log::Dispatch v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation