ch.shamu.jsendnrdp.impl

Class NonBlockingNagiosCheckSender

java.lang.Object

ch.shamu.jsendnrdp.impl.NonBlockingNagiosCheckSender

All Implemented Interfaces:

NagiosCheckSender

public class NonBlockingNagiosCheckSender
extends Object
implements NagiosCheckSender

This implementation uses a bounded queue of alerts to send (jobs).
A ThreadPoolExecutor processes those jobs.
Due to the asynchronous nature of this sender, the only exception that can be thrown by the "send"
method is if the maxQueueSize is reached (IOException). All exception which can occur during job execution are logged.
This implementation features a configurable level of concurrency and throttling of job executions.
This allows to protect the remote nagios server if an application tries to send too many check results too fast.

Constructor Summary

Constructors

Constructor and Description
NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server, int maxQueueSize, double maxRequestsPerSeconds, ThreadPoolExecutor executor) Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling
NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server, int nbThreads, int maxQueueSize) Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling
NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server, int nbThreads, int maxQueueSize, double maxRequestsPerSeconds) Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling

Method Summary

Modifier and Type	Method and Description
void	send(Collection<NagiosCheckResult> checkResults) attempt to send a check result to Nagios
Future	sendAsync(Collection<NagiosCheckResult> checkResults) Send the check results asynchronously, and return a future.
void	shutdown() Shuts down the underlying executor.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NonBlockingNagiosCheckSender

public NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server,
                                    int nbThreads,
                                    int maxQueueSize)

Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling

Parameters:

server - is the nrdp server connection settings

nbThreads - is the number of worker threads for sending nagios alerts (concurrency level)

maxQueueSize - is the maximum number of queued jobs before starting rejecting new job requests (IOException) (0 means go on until OutOfMemory) jobs currently in execution are not taken into account when computing queue size. Note that this version does not throttle job executions.

NonBlockingNagiosCheckSender

public NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server,
                                    int nbThreads,
                                    int maxQueueSize,
                                    double maxRequestsPerSeconds)

Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling

Parameters:

server - is the nrdp server connection settings

nbThreads - is the number of worker threads for sending nagios alerts (concurrency level)

maxQueueSize - is the maximum number of queued jobs before starting rejecting new job requests (IOException) (0 means queue jobs until OutOfMemory, please don't...) jobs currently in execution are not taken into account when computing queue size.

maxRequestsPerSeconds - throttling of requests sent to the server, it's the maximum number of requests send to the server per second (0 means unlimited). The jobs currently in execution will block in order to respect this rate.

NonBlockingNagiosCheckSender

public NonBlockingNagiosCheckSender(NRDPServerConnectionSettings server,
                                    int maxQueueSize,
                                    double maxRequestsPerSeconds,
                                    ThreadPoolExecutor executor)

Bean that knows how to send nagios alerts in a non blocking way, has configurable concurrency level and supports throttling

Parameters:

server - is the nrdp server connection settings

maxQueueSize - is the maximum number of queued jobs before starting rejecting new job requests (IOException) (0 means queue jobs until OutOfMemory, please don't...) jobs currently in execution are not taken into account when computing queue size.

maxRequestsPerSeconds - throttling of requests sent to the server, it's the maximum number of requests send to the server per second (0 means unlimited). The jobs currently in execution will block in order to respect this rate.

executor - executor to use for sending the checks

Method Detail

sendAsync

public Future sendAsync(Collection<NagiosCheckResult> checkResults)
                 throws NRDPException,
                        IOException

Send the check results asynchronously, and return a future. The send() method will also send the results asynchronously, but doesn't return a Future object that can be used to manipulate or query the execution of the actual sending process

Throws:

NRDPException

IOException

send

public void send(Collection<NagiosCheckResult> checkResults)
          throws NRDPException,
                 IOException

Description copied from interface: NagiosCheckSender

attempt to send a check result to Nagios

Specified by:

send in interface NagiosCheckSender

Parameters:

checkResults - is a list of results to send

Throws:

NRDPException - thrown if an error occurs while sending the passive check

IOException - thrown if I/O error occurs while trying to establish connection with nagios host

shutdown

public void shutdown()

Shuts down the underlying executor. No new results should be sent through this sender after this method is invoked.