Creating a custom dashboard using available gadgets in WSO2 ESB Analytics
If you are familiar with the ESB Analytics dashboard you know that we can use it to view statistics of artifacts like proxy services, APIs, sequences, endpoints, and inbound endpoints as you desire. If not you can go through this official documentation to learn all about it [1].
And now that all of us are on the same page, we know that we can view theses statistics under categories such as Request Count, Message Count, Message Latency, Messages, and Message Flows of selected artifacts separately.
Here I’m gonna tell you how to use these available gadgets to create a custom dashboard, and which available gadgets can be used to represent different kinds of statistics in the dashboard. (Eg: Success/Failure rates, Message Latency, TPS)
First of all, let's see how to create a custom dashboard. After logging into the Analytics dashboard using the given URL once the Analytics server is started[2], please click on ‘create dashboard’ to create a new one.
And give the name of your preference for the dashboard. So mine is TestDashboard.
And select a layout, which will be spacious enough to add the gadgets you are going to need.
Now click on the add gadgets icon(marked in red)and you will be given the list of available gadgets.
Now let's see some of the main gadgets used to display statistics in the default dashboard and what are they in the available gadgets.
‘Request Summary’ Gadget
This ‘Request Summary’ gadget is used to display the success and failure rates of the ESB artifacts.
In the available gadgets, this is called the ‘STATS CHART’. We can drag-drop the STATS CHART to our dashboard.
Now we can see the gadget is added but it displays a “No records found -Please select a valid date range to view stats” message.
That means we need to add a date range picker so we could specify withing which range the success and failure counts should be displayed.
After adding the date range picker, we can add this picker as a subscriber to the STATS_CHART gadget. While we are at it we can change the display title of this gadget as well.
Select the gadget configuration button on the top right corner (marked in red in the below image)of the gadget and the configuration box will appear.
We can add the data-range picker as the Events → Subscriber and change the title to “My Request Summary”
So now we can see the statistics are displayed in our custom dashboard.
If we move to the gadgets Message Count and Message Latency, they are too in the gadgets list with a different name.
For both of these gadgets, we use the available gadget ‘LINE CHART’
And set the gadgets roles as below.
- Message Count → rate
- Message Latency → latency
With the date range picker again as the subscriber.
I hope you will find this useful to understand how certain gadgets are used to display statistics in the default dashboard and this knowledge will be useful if you ever need to add them to a custom dashboard. Cheers!
[1]. https://docs.wso2.com/display/ESB500/WSO2+ESB+Analytics
[2].https://docs.wso2.com/display/ESB500/Analyzing+WSO2+ESB+with+the+Analytics+Dashboard
