The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Linux-Systemd-1.172840
River stage one • 1 direct dependent • 1 total dependent
++
/ Linux::Systemd::Journal::Write

NAME

Linux::Systemd::Journal::Write - XS wrapper around sd-journal

VERSION

version 1.172840

SYNOPSIS

  use Linux::Systemd::Journal::Write;

  my $jnl = Linux::Systemd::Journal::Write->new;

  # basic log messages
  $jnl->print('flarg');          # with default log level
  $jnl->print('Hello world', 4); # WARN level

  # add abitrary data to the log entry
  my %hash = (DAY_ONE => 'Monday', DAY_TWO => 'Tuesday', DAY_THREE => 'Wednesday');
  $jnl->send('Here is a message', \%hash); # add abitrary data to the log entry

  # will log "Failed to open file: No such file or directory" and ERRNO=2
  open my $fh, '<', 'nosuchfile'
    or $jnl->perror('Failed to open file');

DESCRIPTION

Log Levels

The log levels use by journald and by "priority" are the same as those use by syslog, so instead of using numeric priorities you can

  use Sys::Syslog ':macros';

giving you access to the LOG_* "level constants"

ATTRIBUTES

app_id

Will be used to set SYSLOG_IDENTIFIER. Defaults to basename($0);

priority

Default log priority. See "Log Levels"

caller_details

Boolean controlling whether to log the CODE_FILE, CODE_LINE, and CODE_FUNC of the caller.

Optional. Defaults to true;

See also systemd.journal-fields(7)

caller_level

If this module is not being used directly, but through some proxy module for instance, caller_level is used to determine the number of frames to look back through.

Optional. Defaults to 0;

METHODS

print($msg, $pri?)

$msg should be either a string. $pri is optional, and defaults to $self->priority

send($msg_or_data, $data?)

If there is one arg, it may be a simple string to log. Or, it could be a hashref or an arrayref. In this case, one of the keys sent MUST be 'message'.

If there are two args, the first must be the string to use as a message, the second a hashref or arrayref. In this case, a key called message should not be set.

Finally, send can also be called with an array of key => values, one of which must be message.

Keys will be uppercased.

perror($msg)

Logs the string of the current set errno, prefixed with $msg.

SEE ALSO

  • Log::Journald

    At some point between me writing this module and getting around to releasing it, another module was released to write the journal.

  • systemd

    The main systemd page.

  • sd-journal(3)

    Man page of the C API

BUGS AND LIMITATIONS

You can make new bug reports, and view existing ones, through the web interface at https://github.com/ioanrogers/Linux-Systemd/issues.

AVAILABILITY

The project homepage is http://metacpan.org/release/Linux-Systemd-Journal/.

The latest version of this module is available from the Comprehensive Perl Archive Network (CPAN). Visit http://www.perl.com/CPAN/ to find a CPAN site near you, or see https://metacpan.org/module/Linux::Systemd/.

SOURCE

The development version is on github at https://github.com/ioanrogers/Linux-Systemd and may be cloned from git://github.com/ioanrogers/Linux-Systemd.git

AUTHOR

Ioan Rogers <ioanr@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2017 by Ioan Rogers.

This is free software, licensed under:

  The GNU Lesser General Public License, Version 2.1, February 1999

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.