The Analytics profile of WSO2 Enterprise Integrator (WSO2 EI) allows you to analyze the statistics related to the message mediation that is carried out in the ESB profile of WSO2 EI. Once the data from the mediation artifacts in the ESB profile are published to the Analytics profile, the dashboard will display the statistics.
...
Panel | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||
|
...
- Open WSO2 Integration Studio and open the REST API artifact.
- Click the REST API icon (in the design view) to open the Properties tab for the REST API.
- To enable the collection of mediation statistics for the REST API, select Enable Statistics (shown above).
To enable mediation tracing for the REST API, select Enable Tracing (shown above).
Note Note that it is not recommended to enable tracing in production environments as it generates a large number of events that reduces the performance of the analytics profile. Therefore, tracing should only be enabled in development environments.
- To enable statistics and tracing for the endpoint artifacts, open the Form view of the endpoint artifact and set the Trace Enabled and Statistics Enabled values to 'True'. For example, see the QueryDoctorEP endpoint:
- Similarly, you can enable tracing and statistics for all the required endpoint artifacts.
- Ensure that all the artifacts are packaged in the composite application:
- Open the
pom.xml
file of the SampleServicesCompositeApplication project, which is already included in the project explorer. - Select the artifacts that need to be included into the CAR file.
- Open the
...
Sending a message
Now that you have the artifacts deployed and configured for statistics monitoring, let's send 8 requests to the ESB profile as explained below.
Tip |
---|
For the purpose of demonstrating how successful messages and message failures are illustrated in the dashboard, let's send 2 of the requests while the back-end service is not running. This should generate a success rate of 75%. |
Create a JSON file called
request.json
with the following request payload.Code Block { "name": "John Doe", "dob": "1940-03-19", "ssn": "234-23-525", "address": "California", "phone": "8770586755", "email": "johndoe@gmail.com", "doctor": "thomas collins", "hospital": "grand oak community hospital", "cardNo": "7844481124110331", "appointment_date": "2025-04-02" }
- Open a command line terminal and execute the following command (six times) from the location where you save the request.json file:
curl -v -X POST --data @request.json http://localhost:8280/healthcare/categories/surgery/reserve --header "Content-Type:application/json"
If the messages are sent successfully, you will receive the following response for each request.
Code Block {"appointmentNo":1, "doctorName":"thomas collins", "patient":"John Doe", "actualFee":7000.0, "discount":20, "discounted":5600.0, "paymentID":"e1a72a33-31f2-46dc-ae7d-a14a486efc00", "status":"Settled"}
- Now, shut down the back-end service (to ensure that the back-end service is inactive) and send two more requests.
Analyze the mediation statistics
Now, let's analyze the statistics generated from the message mediation:
Start the Analytics dashboard:
Panel borderColor #542989 bgColor #ffffff borderWidth 1 Localtabgroup Localtab title On MacOS/Linux/CentOS Open a terminal and execute the following command:
Code Block sudo wso2ei-6.6.0-analytics-dashboard
Localtab title On Windows Go to Start Menu -> Programs -> WSO2 -> Enterprise Integrator 6.6.0 Analytics Dashboard. This will open a terminal and start the Analytics profile.
In a new browser window or tab, open the Analytics dashboard using the following URL: https://localhost:9643/portal. Use
admin
for both the username and password.- Click the Enterprise Integrator Analytics icon shown below to open the dashboard.
View the statistics overview for all the ESB artifacts that have published statistics:
The number of transactions handled by the ESB per second is mapped on a graph as follows.
The success rate and the failure rate of the messages received by the ESB profile during the last hour are mapped in a graph as follows.
The
HealthcareAPI
REST API is displayed under TOP APIS BY REQUEST COUNT as follows.- The three endpoints used for the message mediation are displayed under Top Endpoints by Request Count as shown below.
- In the Top APIS BY Request COUNT gadget, click
HealthcareAPI
to open the OVERVIEW/API/HealthcareAPI page. The following is displayed.- The API Request Count gadget shows the total number of requests handled by the
StockQuoteAPI
REST API during the last hour: - The API Message Count gadget maps the number of successful messages as well as failed messages at different times within the last hour in a graph as shown below.
- The API Message Latency gadget shows the speed with which the messages are processed by mapping the amount of time taken per message at different times within the last hour as shown below.
- The Messages gadget lists all the the messages handled by the
StockQuoteAPI
REST API during the last hour with the following property details as follows. - The Message Flow gadget illustrates the order in which the messages handled by the
StockQuoteAPI
REST API within the last hour passed through all the mediation sequences, mediators and endpoints that were included in the message flow as shown below.
- The API Request Count gadget shows the total number of requests handled by the
In the Top Endpoints by Request Count gadget, click one of the endpoints to view simillar statistics per endpoint.
ChannelingFeeEP
SettlePaymentEP
GrandOaksEP
- You can also navigate to any of the artifacts by using the top-left menu as shown below. For example, to view the statistics of a specific endpoint, click Endpoint and search for the required endpoint.