AnyEvent-ZabbixSender

 view release on metacpan or  search on metacpan

README  view on Meta::CPAN

    I't implements the zabbix version 2.0-3.4 protocol for item data
    submission.

  METHODS
    $zbx = new AnyEvent::ZabbixSender [key => value...]
        Creates a (virtual) connection to a zabbix server. Since each
        submission requires a new TCP connection, creating the connection
        object does not actually contact the server.

        The connection object will linger in the destructor until all data
        has been submitted or thrown away.

        You can specify various configuration parameters. The term @items
        refers to an array with "[key, value, clock]" array-refs.

        server => "$hostname:$port" (default: "localhost:10051")
            The zabbix server to connect to.

        host => $name (default: local nodename)
            The submission host, the "technical" name from tghe zabbix
            configuration.

README  view on Meta::CPAN

        delay => $seconds (default: 0)
            If non-zero, then the module will gather data submissions for up
            to this number of seconds before actually submitting them as a
            single batch.

            Submissions can get batched even if 0, as events submitted while
            the connection is being established or retried will be batched
            together in any case.

        queue_time => $seconds (default: 3600)
            The amount of time a data item will be queued until it is thrown
            away when the server cannot be reached.

        linger_time => $seconds (default: same as "queue_time")
            The amount of time the module will linger in its destructor
            until all items have been submitted.

        retry_min => $seconds (default: 30)
        retry_max => $seconds (default: 300)
            The minimum and maximum retry times when the server cannot be
            reached.

        on_error => $cb->($zbx, \@items, $msg) (default: log and continue)
            Called on any protocol errors - these generally indicate that
            something other than a zabbix server is running on a port. The
            given key-value pairs are the lost items.

        on_loss => $cb->($zbx, \@items) (default: log and continue)
            Will be called when some data items are thrown away (this
            happens if the server isn't reachable for at least "queue_time"
            seconds),

        on_response => $cb->($zbx, \@items, \%response) (default: not
        called)
            Will be called with the (generally rather useless) response form
            the zabbix server.

    $zbx->submit ($k, $v[, $clock[, $host]])
        Submits a new key-value pair to the zabbix server. If $clock is

ZabbixSender.pm  view on Meta::CPAN

our $VERSION = '1.1';

=item $zbx = new AnyEvent::ZabbixSender [key => value...]

Creates a (virtual) connection to a zabbix server. Since each submission
requires a new TCP connection, creating the connection object does not
actually contact the server.

The connection object will linger in the destructor until all data has
been submitted or thrown away.

You can specify various configuration parameters. The term C<@items>
refers to an array with C<[key, value, clock]> array-refs.

=over 4

=item server => "$hostname:$port" (default: C<localhost:10051>)

The zabbix server to connect to.

ZabbixSender.pm  view on Meta::CPAN

If non-zero, then the module will gather data submissions for up to this
number of seconds before actually submitting them as a single batch.

Submissions can get batched even if C<0>, as events submitted while the
connection is being established or retried will be batched together in any
case.

=item queue_time => $seconds (default: C<3600>)

The amount of time a data item will be queued until it is thrown away when
the server cannot be reached.

=item linger_time => $seconds (default: same as C<queue_time>)

The amount of time the module will linger in its destructor until all
items have been submitted.

=item retry_min => $seconds (default: C<30>)

=item retry_max => $seconds (default: C<300>)

ZabbixSender.pm  view on Meta::CPAN

The minimum and maximum retry times when the server cannot be reached.

=item on_error => $cb->($zbx, \@items, $msg) (default: log and continue)

Called on any protocol errors - these generally indicate that something
other than a zabbix server is running on a port. The given key-value pairs
are the lost items.

=item on_loss => $cb->($zbx, \@items) (default: log and continue)

Will be called when some data items are thrown away (this happens if the
server isn't reachable for at least C<queue_time> seconds),

=item on_response => $cb->($zbx, \@items, \%response) (default: not called)

Will be called with the (generally rather useless) response form the
zabbix server.

=back

=cut