{section}
{column:width=60%}

{warning}This version must be installed on [Petals ESB 5.3.0|petalsesb530:Petals ESB 5.3.0]+{warning}

h1. Introduction

This implementation of the SE ASE requires Apache ActiveMQ version 5.15.8+.

h1. Business monitoring

h2. MONIT traces

{include:0 CDK SE Business Monitoring Traces 5.8.0}

h2. Flow tracing activation

{include:0 CDK SE Business Monitoring Flow Tracing Activation 5.8.0}

h2. Flow tracing propagation

** the target service provider or its backend are overloaded or down,
** a DoD of the ASE service provider client
* number of retried requests: an increase of this value should show:
** the target service provider or its backend are overloaded or down,
** the ASE service provider client doesn't respect the SLA
{column}
{column:width=25%}
{panel:title=Table of contents}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}

For example, use the following command to get the number of the requests waiting to be sent to the target service provider:

* Integrating Munin with Naggios, sending messages from Munin to Naggios: [http://munin-monitoring.org/wiki/HowToContactNagios]
* Integrating Munin with Naggios, using Naggios active checks: [http://exchange.nagios.org/directory/Plugins/Uncategorized/Operating-Systems/Linux/check_munin_rrd/details]
* Integrating ActiveMQ with Naggios, using ActiveMQ's command-line tools: {color:#ff0000}{*}TODO{*}{color}

Next, we recommend to define specific Nagios command to interact with ActiveMQ:
* activemq_queue_size: to get the number of pending messages in a queue,
* activemq_queue_traffic: to get the number of transacted messages in queue

According to our environment defined above, create the file 'activemq.cfg' in the directory '/etc/nagios-plugins/config' with the following content:
{code}
# 'activemq_queue_size' command definition
define command{
command_name activemq_queue_size
command_line /usr/lib/nagios/plugins/check_jmx -U service:jmx:rmi:///jndi/rmi://$HOSTADDRESS$:$_HOSTJMXPORT$/jmxrmi -O org.apache.activemq:BrokerName=$ARG1$,Type=Queue,Destination=$ARG2$ -A QueueSize -w $ARG3$ -c $ARG4$
}

# 'activemq_queue_traffic' command definition
define command{
command_name activemq_queue_traffic
command_line /usr/lib/nagios/plugins/check_jmx -U service:jmx:rmi:///jndi/rmi://$HOSTADDRESS$:$_HOSTJMXPORT$/jmxrmi -O org.apache.activemq:BrokerName=$ARG1$,Type=Queue,Destination=$ARG2$ -A EnqueueCount -w $ARG3$ -c $ARG4$
}

According to our environment defined above, create the file 'activemq-nagios2.cfg' in the directory '/etc/nagios3/conf.d' with the following content:
{code}
define host{
use jvm-host
name activmq-host ; The name of this host template
notifications_enabled 1 ; Host notifications are enabled
event_handler_enabled 1 ; Host event handler is enabled
flap_detection_enabled 1 ; Flap detection is enabled
failure_prediction_enabled 1 ; Failure prediction is enabled
process_perf_data 1 ; Process performance data
retain_status_information 1 ; Retain status information across program restarts
retain_nonstatus_information 1 ; Retain non-status information across program restarts
check_command check-host-alive
max_check_attempts 10
notification_interval 0
notification_period 24x7
notification_options d,u,r
contact_groups admins
register 0 ; DONT REGISTER THIS DEFINITION - ITS NOT A REAL HOST, JUST A TEMPLATE!

# Specific attributes
_jmxport 1099 ; Listening port of the JVM JMX agent
}

define hostextinfo{
name activemq-node
notes Petals ESB - SE ASE - ActiveMQ node
icon_image base/activemq.jpg
icon_image_alt Petals ESB/Node
vrml_image base/activemq.jpg
statusmap_image base/activemq.jpg
}

According to our environment defined above, create the file 'activemq-host-node1.cfg' in the directory '/etc/nagios3/conf.d' with the following content:
{code}
define host{
use activemq-host ; Name of host template to use
host_name activemq-node
alias Petals ESB - SE ASE - ActiveMQ node
address 127.0.0.1
_jmxport 1099 ; This value should be set with the JMX
; agent listener port of your ActiveMQ node.
}

{code}
define hostgroup {
hostgroup_name petals-esb
alias Petals ESB
members petals-esb-node-1, petals-esb-node-2, activemq-node
}

{code}
# Define a service to check the queue size of an ActiveMQ queue used by the SE ASE
define service{
host_name activemq-node
service_description se-ase-queue-size
check_command activemq_queue_size!localhost!testQueue!10!50
use generic-service
}

# Define a service to check the traffic of an ActiveMQ queue used by the SE ASE
define service{
host_name activemq-node
service_description se-ase-traffic
check_command activemq_queue_traffic!localhost!testQueue!500!1000
use generic-service
}

{code}<beans ... >
<broker xmlns="http://activemq.apache.org/schema/core" ... >
...
<managementContext>
<managementContext createConnector="true"/>
</managementContext>
...
</broker>
...

{code:none}
[activemq_*]
## The hostname to connect to.
## Default: localhost
#env.JMX_HOST localhost

## The port where the JMX server is listening
## Default: 1099
#env.JMX_PORT 1099

## The username required to authenticate to the JMX server.
## When enabling JMX for a plain ActiveMQ install, no authentication is needed.
## The default username for JMX run by ServiceMix is 'smx'
## Default:
#env.JMX_USER smx

## The password required to authenticate to the JMX server.
## The default password for JMX run by ServiceMix is 'smx'
## Default:
#env.JMX_PASS smx

## Space separated list of destinations to create graphs for.
## Default:
env.DESTINATIONS Queue:foo Queue:bar

## You can override certain configuration variables for specific plugins
#[activemq_traffic]
#env.DESTINATIONS Topic:MyTopic Queue:foo

# Download the Perl script {{[check_munin_rdd.pl|http://exchange.nagios.org/components/com_mtree/attachment.php?link_id=1168&cf_id=24]}} into the Nagios plugins directory (under Ubuntu: {{/usr/lib/nagios/plugins}}),

# create the file {{munin.cfg}} in the directory {{/etc/nagios-plugins/config}} (except for Ubuntu, adapt the directory name to your operating system).
# check that the owner file and permissions are the same as other ones (root, and 644). Fix them if needed.
# edit the previous file with the following content:
{code}
define command{
command_name check_munin
command_line /usr/lib/nagios/plugins/check_munin_rrd.pl -H $HOSTALIAS$ -M $ARG1$ -w $ARG2$ -c $ARG3$
}

# create the file {{generic-munin-service.cfg}} in the directory {{/etc/nagios3/conf.d}} (except for Ubuntu, adapt the directory name to your operating system).
# check that the owner file and permissions are the same as other ones (root, and 644). Fix them if needed.
# edit the previous file with the following content:
{code}
define service{
name generic-munin-service ; The 'name' of this service template
active_checks_enabled 1 ; Active service checks are enabled
passive_checks_enabled 0 ; Passive service checks are enabled/accepted
parallelize_check 1 ; Active service checks should be parallelized (disabling this can lead to major performance problems)
obsess_over_service 1 ; We should obsess over this service (if necessary)
check_freshness 0 ; Default is to NOT check service 'freshness'
notifications_enabled 1 ; Service notifications are enabled
event_handler_enabled 1 ; Service event handler is enabled
flap_detection_enabled 1 ; Flap detection is enabled
failure_prediction_enabled 1 ; Failure prediction is enabled
process_perf_data 1 ; Process performance data
retain_status_information 1 ; Retain status information across program restarts
retain_nonstatus_information 1 ; Retain non-status information across program restarts
notification_interval 0 ; Only send notifications on status change by default.
is_volatile 0
check_period 24x7
normal_check_interval 5 ; This directive is used to define the number of "time units" to wait before scheduling the next "regular" check of the service.
retry_check_interval 3 ; This directive is used to define the number of "time units" to wait before scheduling a re-check of the service.
max_check_attempts 2 ; This directive is used to define the number of times that Nagios will retry the service check command if it returns any state other than an OK state. Setting this value to 1 will cause Nagios to generate an alert without retrying the service check again.
notification_period 24x7
notification_options w,u,c,r
contact_groups admins
register 0 ; DONT REGISTER THIS DEFINITION - ITS NOT A REAL SERVICE, JUST A TEMPLATE!
}

In main use-cases, the ActiveMQ server is collocated with the Petals ESB node running the SE ASE. So, it is a good practice to define ActiveMQ as a service of the Petals node running the SE ASE:
# edit the Nagios configuration file of your Petals ESB node (for example: {{/etc/nagios3/conf.d/petals-esb-host-node1.cfg}}, following the monitoring Petals ESB sample),
# and add the following content:
{code}
# Define a service to check the queue size of an ActiveMQ queue used by the SE ASE
define service{
host_name petals-esb-node-1
service_description se-ase-queue-size
check_command check_munin!activemq_size!10!50
use generic-munin-service
}

# Define a service to check the traffic of an ActiveMQ queue used by the SE ASE
define service{
host_name petals-esb-node-1
service_description se-ase-queue-traffic
check_command check_munin!activemq_traffic!500!1000
use generic-munin-service
}
{code}

In our example:
- in nominal running, we should not have more than 10 pending messages. Over 50 pending messages, an error is thrown.
- and according to our volumetric estimations, we should not have more than 500 messages per 5 min. We accept up to twice our estimation: 1000 messages per 5 min.

Next, restart Nagios, start Petals and ActiveMQ. Go to the Nagios console:

On network domain configuration error, the message "{{I can't guess your domain, please add the domain manually}}" can appear on services associated to the queue size and queue traffic. So update:
- the command {{check_munin}} to force the domain name, example:
{code}
define command{
command_name check_munin
command_line /usr/lib/nagios/plugins/check_munin_rrd.pl -H localhost.localdomain -d localdomain -M $ARG1$ -w $ARG2$ -c $ARG3$
}