{section}
{column}

h1. Introduction

Cacti is a complete monitoring and graphing tool to present historical data coming from monitoring probes.


[Get more details about Cacti.|http://www.cacti.net/]

The integration of Petals ESB and Cacti is to get information about the JVM. This is done using SNMP probes.

{column}
{column:width=350px}

{panel:title=Monitoring Petals ESB with Cacti}{toc}{panel}
{panel:title=Contributors}{contributors:order=name|mode=list}{panel}
{column}
{section}

h1. Installation


h2. Cacti installation

The Cacti integration was experienced on a Linux distribution "Ubuntu Precise Pangolin (12.04)".

Cacti is available in version 0.8.7i through the default Ubuntu repository. So, just install the package "cacti" using the standard way.

h2. Enabling the SNMP agents of the Petals ESB JVMs
{include:Enabling the SNMP agent of a Petals ESB JVM}

h2. Cacti configuration

Import in your Cacti configuration the content of the attachment [^cacti_host_template_jvm_host.xml]
Next, create the following datasource from templates:
!ds.jpg|align=center!



Next, create your graphs from templates:
!graph.jpg|align=center!

h1. Monitoring

h2. Monitoring the container

h3. Monitoring the delivered messages of the local transporter

Metrics about delivered messages by the local transporter are available into the Petals container. A usage of these metrics can be the delivered messages by message exchange status whatever the endpoint, the service and the interface:
!petals-delivered-messages.png|align=center!

This is done using a simple *script/command* to collect metric values.

To create this graph, please follow the following steps:
# First, create a new *Data Input Method*:
!petals-container-localtransporter-dim.jpg|align=center!
Cacti monitoring extension of Petals CLI is used to get metric values.
In the *Input String*, you will put the command line arguments to connect to the the Petals node for which you want to graph the delivered messages of the local transporter. That's why the command line contains: *<petals_host>*, *<petals_jmx_port>*, *<petals_jmx_user>* and *<petals_jmx_password>*.
# Add an *input field* for your Petals node hostname
!petals-container-localtransporter-dim-petals-host.jpg|align=center!
As the Petals node hostname can be automatically set from the hostname of the monitored host, the field *Special Type Code* is set.
# Add others *input fields*
!petals-container-localtransporter-dim-petals-jmx-port.jpg|align=center!
As for the JMX port, create an input field for the Petals JMX username and the Petals JMX user password.
# Add the *output fields* returned by the script
For each message exchange status "Active", "Done" and "Error", create an output field:
!petals-container-localtransporter-dim-output-active.jpg|align=center!
# Check that you have the following *Data Input Method*:
!petals-container-localtransporter-dim-full.jpg|align=center!
# Create a new *Data Template*:
!petals-container-localtransporter-dt.jpg|align=center!
Select your data input method previously created as *Data Input Method*.
Add your first *data item* associated to the number of delivered messages for message exchange status 'Active'. The *data source type* of the item is *COUNTER*.
# Create two others *data items* associated to the number of delivered messages for message exchange status 'Done' and 'Error'
!petals-container-localtransporter-dt-items.jpg|align=center!
# A new block *Custom data* appears, check *Use Per-Data Source Value* for all except for the Petals node hostname
!petals-container-localtransporter-dt-custom.jpg|align=center!
# Create a new *Graph Template*:
!petals-container-localtransporter-gt.jpg|align=center!
# Add a *Graph Item* to displayed graph the number of delivered messages for message exchange status 'Active'
!petals-container-localtransporter-gt-active.jpg|align=center!
# Add a *Graph Item* to displayed the legend of the number of delivered messages for message exchange status 'Active'
!petals-container-localtransporter-gt-active-legend.jpg|align=center!
# Add others *Graph Items* associated to the number of delivered messages for message exchange status 'Done' and 'Error'
!petals-container-localtransporter-gt-full.jpg|align=center!
# Create a *New Graph*
!petals-container-localtransporter-ng.jpg|align=center!
# Set parameters needed to the *Data Input Method*
!petals-container-localtransporter-ng-params.jpg|align=center!

This is done using a *data query* to collect metric values. The data query definition to put in the XML file is:
{code}
<interface>
<name>Get Delivered Messges by the Local transporter to an endpoint</name>
<script_path>/home/cdeneux/petals-cli-2.1.1-SNAPSHOT/bin/petals-cli.sh</script_path>
<arg_prepend>-h localhost -n 7700 -u petals -p petals -c -- monitoring -o local-transporter -f delivered-messages</arg_prepend>
<arg_index>-- -l endpoint</arg_index>
<arg_query>-- -l endpoint -q</arg_query>
<arg_get>-- -l endpoint -q</arg_get>
<output_delimeter>!</output_delimeter>
<index_order>endpointName</index_order>
<index_order_type>alphanumeric</index_order_type>
<!--index_title_format>|chosen_order_field|</index_title_format-->

<fields>
<endpointName>
<name>Endpoint name</name>
<direction>input</direction>
<query_name>NAME</query_name>
</endpointName>
<activeDeliveredMsgs>
<name>Active Message exchange delivered counter</name>
<direction>output</direction>
<query_name>ACTIVE</query_name>
</activeDeliveredMsgs>
<doneDeliveredMsgs>
<name>Done Message exchange delivered counter</name>
<direction>output</direction>
<query_name>DONE</query_name>
</doneDeliveredMsgs>
<errorDeliveredMsgs>
<name>Error Message exchange delivered counter</name>
<direction>output</direction>
<query_name>ERROR</query_name>
</errorDeliveredMsgs>
</fields>
</interface>
{code}
Don't forget to adapt the path of Petals CLI to your installation

To create this graph, please follow the following steps:

!petals-container-localtransporter-itf-dt.jpg|align=center!
Select "*Get Script Data (Indexed)*" as *Data Input Method*.
Add your first *data item* associated to the number of delivered messages for message exchange status 'Active'. The *data source type* of the item is *COUNTER*.
# Create two others *data items* associated to the number of delivered messages for message exchange status 'Done' and 'Error'
!petals-container-localtransporter-itf-dt-items.jpg|align=center!
# A new block *Custom data* appears, check *Use Per-Data Source Value* for all
!petals-container-localtransporter-itf-dt-custom.jpg|align=center!
# Create a new *Graph Template*:
!petals-container-localtransporter-itf-gt.jpg|align=center!
# Add a *Graph Item* to displayed graph the number of delivered messages for message exchange status 'Active'
!petals-container-localtransporter-itf-gt-active.jpg|align=center!
# Add a *Graph Item* to displayed the legend of the number of delivered messages for message exchange status 'Active'
!petals-container-localtransporter-itf-gt-active-legend.jpg|align=center!
# Add others *Graph Items* associated to the number of delivered messages for message exchange status 'Done' and 'Error'
!petals-container-localtransporter-itf-gt-full.jpg|align=center!
# Go to the *data query* previoulsy created, and associate it the just create graph template
!petals-container-localtransporter-itf-dq-associate.jpg|align=center!
# Associate outputs of the *data query* to the *graph items*
!petals-container-localtransporter-itf-dq-associate-output.jpg|align=center!
*Don't forget to check boxes.*
# Go to the *device* for which you want to create the graph, and *Create Graphs for this Host*
!petals-container-localtransporter-itf-ng.jpg|align=center!
Select yours endpoints for which you want create a graph

The new graph can be viewed after several minutes needed to collect data. By default a collect is done every 5 minutes. To view the graph, go into *Graph management"