Monitoring BRS Using BAM

WSO2 Business Rules Server (BRS) can be monitored using the Business Activity Monitor (BAM). Follow the steps below to run this functionality.

Step 1: Start the Business Rules Server

Before starting the BRS, carry out the following actions.

• Go to BRS_Home/repository/conf and open carbon.xml.
  Look for <offset>0</offset> and change it to 1. 
• Go to BRS_Home/repository/conf/etc and open bam.xml.
Look for <ServiceDataPublishing>disable</ServiceDataPublishing> and enable it.

Start the BRS. See Starting the server for more information.

Step 2: Start the Business Activity Monitor

1. Start BAM. For more information, see Starting the server.
2. If you need to change databases which stores statistic data: 
   
   • Create a database.
   • Configure the database in {BAM_HOME}/repository/conf/datasources/master-datasources.xml as WSO2BAM_DATASOURCE.

Step 3: Configure the Business Rules Server

1. Log into the BRS management console.
2. Click on the Configuration tab and then click Server Roles.
3. Select the Enable service statistics monitoring check box.
   
4. Leave the values of Stream Name, Version,Nick Name, Description fields unchanged. If you want to change them, you will have to make some more changes in the tool box and hive script.
5. Enter the Receiver URL. 
   This refers to the Thrift URL. This is normally tcp://{host}:7611. If you need to use SSL for this the URL will be tcps://{host}:7711. If you change the offset of the BAM server to 1, both ports will be incremented by 1 (7612, 7712).
6. Enter the Cassandra username in the Username field.
7. Enter the Cassandra password in the Password field.
8. Click Update to save the configuration information you entered.

Step 4: Configure the Business Activity Monitor

1. Log into the BAM management console.

2. On the Main menu, under BAM Toolbox, click Add to open the Add Tool Box page.
   

3. Select the  ToolBox From File System option. Click Choose File and select the required file from the BAM_Home/samples/toolboxes/Service_Statistics_Monitoring.tbox path.

4. Click Install. Refresh after a few seconds to see if the toolbox is installed.

Step 5: Invoke a service

Before you invoke the service, it should be deployed as explained in Samples.

To invoke a service:

1. Log into the BRS management console.
2. Click on the Main tab and then click List to open the Deployed Services page.
3. Invoke the required service. The Greeting service will be used in this example. See Deploying and testing the service for information on how to invoke this service.

Step 6: View published data

1. Log into the BRS management console.
2. Click on the Tools tab and then click Explore Cluster under Cassandra Explorer to open the Keyspaces page.
    
3. Click bam_service_data_publisher to open the EVENT_KS : bam_service_data_publisher page where basic information relating to the activity carried out in the BRS is displayed as follows.
    
4. Click View More to view detailed information relating to the event. For example, the following is displayed in this example.
   
5. Click on the Main tab and click BAM Dashboards. 
6. Log in using your user name and password.
7. Select the required server, service and operation to view service statistics via the BAM Dashboard.
8. Click either All, Month, Day or Now based on the time period for which you want to view statistics. The  statistics will be graphically displayed as shown below  for the Greeting service which is used as an example for this procedure.