This documentation is for WSO2 Business Activity Monitor 2.0.0. View documentation for the latest release.

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Current »

The "Activity Monitoring Toolbox" is a default, out-of-the-box toolbox provided by WSO2 BAM for point-and-click installation. It includes the necessary artifacts (hive scripts, data stream definitions, properties files, gadgets etc.) required to collect and monitor activity related to services deployed in any WSO2 service-hosting product like the WSO2 Enterprise Service Bus, WSO2 Application Server, WSO2 Data Services Server etc.

Explained below is a complete, example use case of how to extract and summarize service statistics of the WSO2 Application Server using this toolbox. The following sections are covered:

Prerequisites of the Usecase

1. Download and start the WSO2 BAM server and log in to its management console. Instructions are given in section Installation Guide.

2. Set up the either "BAM Service Statistics Data Agent" in a selected service-hosting WSO2 product of which, you plan to gather and summaries service statistics or "BAM Mediator" in WSO2 ESB. In this example usecase, we have used the WSO2 Enterprise Service Bus (ESB). For instructions on setting it up to transfer service data to WSO2 BAM, refer to section BAM Mediator. Else, you can pump some sample service statistics simply by running ant command in $bam_home/samples/activity-monitoring.

Note

Activity monitoring toolbox comes with this sample is using embedded H2 database to persist summarized data, also out of the box it only works for default bam installation. Therefore if you changed the default settings(port offset and h2 database), you have to change hive script accordingly. eg:-  If BAM server offset=1, you should update the script as, "cassandra.port" = "9161"

Installing the Toolbox 

1. Log in to BAM's management console and select "BAM Toolbox -> Add" in the "Main" menu.


2. The "Add Tool Box" page appears. Select the "ToolBox From File System" and browse to $bam_home/samples/toolboxes/Activity_Monitoring.tbox. Then click "Install" button. With this simple step, all required artifacts will be deployed to BAM.


3. The "Available BAM Tool Boxes" page opens with the installation status as "Installing". Wait a few seconds and refresh the page to see the status changed to "Installed".


Executing the Analytics Scripts

1. After installing the toolbox, navigate to "Analytics -> List" in the "Main" menu.

2. When installing the Toolbox, an analytics script is added for execution. It can simply be executed to display statistics on the dashboard. Click the "Execute" link associated with it.

Displaying Statistics on Dashboard

1. After running the hive script, navigate to "Dashboard" in the "Main" menu.

2. You should be able to see all activity Ids received of a given date-time range. For example,

3. By clicking on the "Explore" button, all the messages related to the selected activity ID in the given date-time range will be displayed.

4. Other data related to message other than header and body will be displayed when clicked on the green "Explore" button.

 

  • No labels