NAME

XT::Files::Role::Logger - logging role

VERSION

Version 0.002

SYNOPSIS

    use Role::Tiny::With;
    with 'XT::Files::Role::Logger';

    $self->log($message);
    $self->log_debug($message);
    $self->log_fatal($message);

DESCRIPTION

This Role::Tiny role adds logging functionality to all XT::Files classes.

USAGE

log ( MESSAGE )

Logs the message with Test::Builders note method. This should be used for all output instead of just printing it to work nicely with the Perl testing environment.

log_debug ( MESSAGE )

Logs the message with log but only if the environment variable XT_FILES_DEBUG is set and true.

log_fatal ( MESSAGE )

Logs the message with log, then dies with Carps confess.

log_prefix

Returns the prefix that is prepended to every logged message. Defaults to the objects class.

Method can be overwritten to change the prefix.

SEE ALSO

XT::Files, Carp, Test::Builder

SUPPORT

Bugs / Feature Requests

Please report any bugs or feature requests through the issue tracker at https://github.com/skirmess/XT-Files/issues. You will be notified automatically of any progress on your issue.

Source Code

This is open source software. The code repository is available for public review and contribution under the terms of the license.

https://github.com/skirmess/XT-Files

  git clone https://github.com/skirmess/XT-Files.git

AUTHOR

Sven Kirmess <sven.kirmess@kzone.ch>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2019 by Sven Kirmess.

This is free software, licensed under:

  The (two-clause) FreeBSD License