NAME

Log::Dispatch::Gelf - Log::Dispatch plugin for Graylog's GELF format.

SYNOPSIS

use Log::Dispatch;

my $sender = ... # e.g. RabbitMQ queue.
my $log = Log::Dispatch->new(
    outputs => [ 
        #some custom sender
        [
            'Gelf',
            min_level         => 'debug',
            additional_fields => { facility => __FILE__ },
            send_sub          => sub { $sender->send($_[0]) },
        ],
        #or send to graylog via TCP/UDP socket
        [
            'Gelf',
            min_level         => 'debug',
            additional_fields => { facility => __FILE__ },
            socket            => {
                host     => 'graylog.server',
                port     => 21234,
                protocol => 'tcp',
            }
        ]
    ],
);
$log->info('It works');

DESCRIPTION

Log::Dispatch::Gelf is Log::Dispatch plugin which formats the log message according to Graylog's GELF Format version 1.1 and sends it using user-provided sender.

The constructor takes the following parameters in addition to the standard parameters documented in Log::Dispatch::Output:

• additional_fields

  optional hashref of additional fields of the gelf message (no need to prefix them with _, the prefixing is done automatically).

• chunked

  optional scalar. An integer specifying the chunk size or the special string values 'lan' or 'wan' corresponging to 8154 or 1420 respectively.

  Chunking is only applicable to UDP connections.

• compress

  optional scalar. If a true value the message will be gzipped with IO::Compress::Gzip.

• send_sub

  mandatory sub for sending the message to graylog. It is triggered after the gelf message is generated.

• socket

  optional hashref create tcp or udp (default behavior) socket and set send_sub to sending via socket

LICENSE

Copyright (C) Avast Software.

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

AUTHOR

Miroslav Tynovsky <tynovsky@avast.com>