NAME

C<Log::Dispatch::TTY> - console destination with color support


DESCRIPTION

This log destination sends lines of log onto the console. If the console is a TTY (i.e. not a redirection into a file or
a pipe) then the lines of output are colored according to message levels.


ATTRIBUTES

head

If I<True> (which is the default) then the output would be colored. But only if the console is a TTY.


If set then it must be an opened file handle.


METHODS

If an instance of this class is created with C<:console> named argument passed into the constructor then any output
file handle is considered a TTY and the output will be colored if C<$.color> flag is set:


code

=begin code :lang<raku>
    my $logger = Log::Dispatch.new;
    $logger.add: 'TTY', :console, :color; # Always use ANSI colors
=end code


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

C<Log::Dispatch::Types> - standard types used by the C<Log::Dispatch> module


Currently the only type this module provides is C<LOG-LEVEL> enumeration (exported) with the following values:


item

Types

C<Log::Dispatch::Source> - role providing logging source interface


This role implements all basic functionality necessary to provide a source of log messages.


If set provides source name. In a log file line it would be represented in square brackets sitting next to the message
level. Something like:


1970-01-31 01:02:03 [    ALERT] [MySource] Ouch!


Dispatch a new log message. The method creates a new L<C<Log::Dispatch::Msg>|Msg.md> object and submits it into the dispatcher.
For exmaple:


=begin code :lang<raku>
class MyApp does Log::Dispatch::Source {
    method some-action {
        my $success;
        ...
        if $success {
            self.log: "The action succeeded";
        }
        else {
            self.log: "Too bad! Something went wrong", :critical;
        }
    }
}
=end code


Note that multiple level named arguments can be used, but the method would throw for any unknown one and will chose the
one with the most critical level among the valid ones. I.e., would it happen so that both `:critical` and `:debug` are
nameds are used then `:critical` would win the duel.


This method is to be defined by the consuming class if it wants to define the source name. To get a log line looking
like in the example for attribute C<$.name> one has to have this method as:


Must never be used and better be not overriden without a B<really> good reaon.


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


Source

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


TTY

NAME

ATTRIBUTES

`Bool:D $.color`

`IO::Handle $.tty`

METHODS

`submethod TWEAK(Bool:D :$console)`

SEE ALSO

AUTHOR

Log::Dispatch v0.0.1

Authors

License

Dependencies

Test Dependencies

Provides

Documentation