{section}
{column}

h1. Introduction

The probes available in the Petals internals and components are able to send JMX notifications when they detect a defect. These notifications can be sent to Nagios with a dedicated monitoring command of Petals CLI that receive JMX notifications and write them in the channel of Nagios passive checks.

{gliffy:name=Nagios passive checks|size=L|align=center|version=2}

The daemon *{{petals-cli-nagios}}* listen JMX notifications coming from Petals ESB nodes using a dedicated Petals CLI command. When it receives a JMX notification, it formats and prints an external command for Nagios. The host and service emitting the JMX notification are transformed into Nagios host and Nagios service through a mapping file.

{column}
{column:width=350px}
{panel:title=Table of contents}{toc:outline=true}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list|showAnonymous=true|showCount=true|showLastTime=true}{panel}
{column}
{section}

h1. Installation

Once your Nagios installation is configured to accept external commands, you must verify in {{/etc/petals-cli/petals-cli-nagios}} that the expected Nagios pipe file is set according to your Nagios installation. The default value is the one associated to the Debian package of Nagios.

To add a new defect subscription to sent to Nagios:
# create a new file in the directory {{/etc/petals-cli/nagios-subscriptions-available}} from the template {{/etc/petals-cli/nagios-subscriptions-available/nagios-subscription-template}}:
{code}
# JMX connection information to the Petals ESB container
#
host=localhost
port=7700
username=petals
password=petals

# The subscription object and its arguments
#
subscription-object=petals-bc-soap
extra-args=-n petals-bc-soap -t file:///etc/petals-cli/nagios-mapping-rules.properties
{code}
where the first part is the required JMX connection information to establish a communication with a Petals ESB container, and the second part is dedicated to the wanted defect.
# configure the file {{/etc/petals-cli/nagios-mapping-rules.properties}} to map the hosts and services declared into Nagios with your Petals ESB installation,
#* the Nagios host is to associate to the defect emitter (see [defect details|#defect_details]),
#* the Nagios service is to associate to the defect identifier (see [defect details|#defect_details]).
# you can test your defect subscription using the script {{/usr/bin/petals-cli-nagios}}:
{code}
> sudo /usr/bin/petals-cli-nagios <your-defect-subscription-file>
{code}
# once your defect subscription is working, just create a link into the directory {{/etc/petals-cli/nagios-subscriptions-enable}}, and restart the service {{petals-cli-nagios}}.

{anchor:defect_details}
h1. Supported defects

h2. Components

h3. Petals BC SOAP

The defects of the BC SOAP are supported by the subscription object '*petals-bc-soap*'. This subscription object requires the extra arguments:
* '*-n <component-id>*': The JBI identifier of the Petals BC SOAP,
* '*-t <mapping-files>*': The Nagios mapping file '{{/etc/petals-cli/nagios-mapping-rules.properties}}.

The defect emitter identifier is based on the template: *{{<component-id>@<hostname>}}*, where <component-id> is the JBI identifier of the BC SOAP sending the defect from the Petals ESB container running on <hostname>.

The following defects can be notified:
|| Defect || Identifier ||
| HTTP thread pool exhausted | *{{org.ow2.petals.bc.soap.httpserver.threadpool.exhausted}}* |
| Web-service client pool exhausted | *{{org.ow2.petals.bc.soap.serviceclientspool.exhausted}}* |