Using the Analytics Dashboard

WSO2 ESB Analytics Dashboard is used to publish information relating to the message mediation in WSO2 ESB. The statistics are published in the analytics dashboard in an overview as well as for individual artifacts that are deployed within ESB.

In this tutorial, you use the ESB Analytics dashboard to view and analyze the Service Chaining tutorial mediation statistics.

Before you begin,

Install Oracle Java SE Development Kit (JDK) version 1.8.* and set the JAVA_HOME environment variable.
Go to http://wso2.com/products/enterprise-service-bus/, click DOWNLOAD to download the ESB runtime ZIP file, and then extract the ZIP file.
The path to this folder will be referred to as <ESB_HOME> throughout the tutorials.
Go to http://wso2.com/products/enterprise-service-bus/, click Tooling to select and download the relevant ESB tooling ZIP file, and then extract the ZIP file.
The path to this folder will be referred to as <TOOLING_HOME> throughout the tutorials.
For more detailed installation instructions, see the Installing WSO2 ESB Tooling.
Go to http://wso2.com/products/enterprise-service-bus/, click Analytics to download the ESB analytics ZIP file, and then extract the ZIP file.
The path to this folder will be referred to as <ANALYTICS_HOME> throughout the quick start guide.
Open the ESB Tooling environment and click File -> Import. Then, select Existing WSO2 Projects into workspace under the WSO2 category, click Next and upload the extracted pre-packaged C-App project. This C-App contains the configurations of the service chaining tutorial. On the Servers tab, right-click the WSO2 ESB server, select Add and Remove and choose SampleServicesCompositeApplication, and click Finish.

If you do not have a server added in Eclipse, refer this tutorial.
You can also deploy the artifacts to the ESB server using a Composite Application Archive (CAR) file.
If you are running on Windows, download the snappy-java_1.1.1.7.jar from here and copy the JAR file to <ANALYTICS_HOME>\repository\components\lib directory.

Let's get started!

Setting up Analytics

Set the following properties in the <ESB_HOME>/repository/conf/synapse.properties file to true so that the ESB can publish mediation statistics:

...
mediation.flow.statistics.enable=true
mediation.flow.statistics.tracer.collect.payloads=true
mediation.flow.statistics.tracer.collect.properties=true
...
mediation.flow.statistics.collect.all=true

Start the WSO2 ESB Analytics server by going to <ANALYTICS_HOME>/bin using the Command-Line/Terminal and executing one of the following commands:
- On Linux/Mac OS: sh wso2server.sh
- On Windows: wso2server.bat --run
Start WSO2 ESB server from within ESB Tooling as described in here OR by navigating to <ESB_HOME>/bin using the Command-Line/Terminal and executing one of the following commands:

On Linux/Mac OS: sh wso2server.sh
On Windows: wso2server.bat --run

Ensure you have successfully started the Analytics server prior to starting the ESB server.

Analyzing the mediation statistics

In a new browser window or tab, open https://localhost:9444/carbon/ and log into the Analytics management console using admin for both the username and password.
On the Main tab, click Analytics Dashboard and log in using admin for both the username and password. You will then see the following:
Click View to open the ESB Analytics Dashboard. The OVERVIEW page is displayed by default.
To view statistics for the REST API, click API on the left navigator and search for HealthcareAPI . For more information on analyzing statistics displayed on this page, see Analyzing Statistics for REST APIs.
To view statistics for an endpoint, click ENDPOINT on the left navigator and search for the required endpoint. You can view statistics for the following endpoints on this page:
- GrandOaksEP
- PineValleyEP
- ClemencyEP
- ChannelingFeeEP
- SettlePaymentEP
For more information on analyzing statistics displayed on this page, see Analyzing Statistics for Endpoints.

You have now explored how to use WSO2 ESB Analytics dashboard.