Scroll to navigation

Log::Any::Adapter::Syslog(3pm) User Contributed Perl Documentation Log::Any::Adapter::Syslog(3pm)

NAME

Log::Any::Adapter::Syslog - Send Log::Any logs to syslog

VERSION

version 1.707

SYNOPSIS

    use Log::Any::Adapter 'Syslog';
    # ... or ...
    use Log::Any::Adapter;
    Log::Any::Adapter->set('Syslog');

    # You can override defaults:
    Log::Any::Adapter->set(
        'Syslog',
        # name defaults to basename($0)
        name     => 'my-name',
        # options default to "pid"
        options  => "pid,ndelay",
        # facility defaults to "local7"
        facility => "mail"
    );

DESCRIPTION

Log::Any is a generic adapter for writing logging into Perl modules; this adapter use the Sys::Syslog module to direct that output into the OS's logging system (even on Windows).

CONFIGURATION

"Log::Any::Adapter::Syslog" is designed to work out of the box with no configuration required; the defaults should be reasonably sensible.

You can override the default configuration by passing extra arguments to the "Log::Any::Adapter" method:

name
The name argument defaults to the basename of $0 if not supplied, and is inserted into each line sent to syslog to identify the source.
options
The options configure the behaviour of syslog; see Sys::Syslog for details.

The default is "pid", which includes the PID of the current process after the process name:

    example-process[2345]: something amazing!
    

The most likely addition to that is "perror" (non-POSIX) which causes syslog to also send a copy of all log messages to the controlling terminal of the process.

facility
The facility determines where syslog sends your messages. The default is "local7", which is not the most useful value ever, but is less bad than assuming the fixed facilities.

See Sys::Syslog and syslog(3) for details on the available facilities.

log_level
Minimum log level. All messages below the selected level will be silently discarded. Default is debug.

If LOG_LEVEL environment variable is set, it will be used instead. If TRACE environment variable is set to true, level will be set to 'trace'. If DEBUG environment variable is set to true, level will be set to 'debug'. If VERBOSE environment variable is set to true, level will be set to 'info'.If QUIET environment variable is set to true, level will be set to 'error'.

AUTHORS

  • Jonathan Swartz <swartz@pobox.com>
  • David Golden <dagolden@cpan.org>
  • Doug Bell <preaction@cpan.org>
  • Daniel Pittman <daniel@rimspace.net>
  • Stephen Thirlwall <sdt@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017 by Jonathan Swartz, David Golden, and Doug Bell.

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

2018-12-08 perl v5.28.1