1. Generating insight from WSO2 API
Manager Statistics
Dinusha Senanayake, Amila De Silva
WSO2

2. About the Presenters
Dinusha joined WSO2 in September 2010. She is a
senior software engineer in the WSO2 API Manager
team where she mainly focuses on the development of
the product. In addition to her product development
efforts she has provided development support and
technology consulting on customer engagements,
including customer QuickStart programs focused on SOA
integration.
Amila joined WSO2 in September 2012. he is a software
engineer in the WSO2 API Manager team. In addition to
his product development efforts he has provided
development support and technology consulting on
customer engagements, including customer QuickStart
programs.

3. About WSO2
๏
๏
Global enterprise, founded in
2005 by acknowledged leaders
in XML, web services
technologies, standards and
open source
Provides only open source
platform-as-a-service for
private, public and hybrid cloud
deployments
๏
All WSO2 products are 100%
open source and released
under the Apache License
Version 2.0.
๏
Is an Active Member of OASIS,
Cloud Security Alliance, OSGi
Alliance, AMQP Working Group,
OpenID Foundation and W3C.
๏
Driven by Innovation
๏
Launched first open source
API Management solution
in 2012
๏
Launched App Factory in
2Q 2013
– Launched Enterprise Store
and first open source Mobile
solution in 4Q 2013

4. Insights
Insights
Operational
Useful when
scaling up
the system/upgrading
system resources
Business
Useful for
expanding business
/ API Ecosystem

5. Operational Insights

6. Operational Insights
๏
Production Systems involve many nodes
๏
Operational conditions change over the time
๏
Nodes can become non-responsive at certain times.
๏
It's hard to monitor many different machines all the time
๏
Performance Hits – Why they occur?
๏
๏
Certain situations are transient – Observed repeatedly but hard to
re-create
System resources may not be fully utilized
๏
Bottlenecks may be occurring at unsuspecting locations – but
remedies are applied to entirely different places.

7. What's available in the
platform?
๏
Tracing a call across many different servers.
๏
Useful for doing RCAs and figuring out the actual problem.
๏
Perform Retrospective analysis using offline data – May provide
clues how to detect possible failures early.
๏
Using CEP to analyze runtime conditions
๏
CEP can measure changes in operational parameters –
CPU,Memory, Response Times
๏
Can trigger alerts when certain changes occur under a pattern.

8. Structure of an Event
Name : Value
Description : Publish Message Tracing Event
Name
: BAM_MESSAGE_TRACE
Nick_Name : MessageTracerAgent
StreamId : BAM_MESSAGE_TRACE:1.0.0
Timestamp : 1393227712801
Version: 1.0.0
correlation_activity_id :
1667815083593519812943
meta_host : 192.168.151.1:9765
meta_server : Application Server
payload_message_direction : OUT
payload_operation_name : greet
payload_service_name : HelloService
payload_status : success
payload_timestamp: 1393227712801

9. A Typical Deployment

10. Message Tracking - BAM

11. Message Tracking - CEP

12. Business Insights

13. Sample - Pizzashack
๏
Consists of three APIs
๏
Menu – Retrieves all different Pizzas available
๏
Order – Places and order, get the state of an order.
๏
Delivery – Invoked when a delivery is done, change the state of an
order
๏
Web Application uses these APIs
๏
End users log into the Web App and place orders.
๏
Data will be collected when users place the orders. These will be used
for generating statistics.
๏
In this sample Pizzashack Owner is the Service Providers

14. Parties in an Ecosystem

15. Parties In an Ecosystem..
Business Owners
Goal : Increase Sales volume
1.Retain existing customers.
2.Introduce new Offers.
3.Group common Items together.
API Creators
Goal:Model Better APIs
1.Expose only right amount of Data.
2.Combine fine granular APIs
APP Developers
Goal:Increase App Downloads
1.Improve User Experience
2.Increase availability
on different platforms

16. Parties In an Ecosystem..
Business Owners
What : Business Related Data
, Request Payloads
1.Find commonly moving items.
2.Individual customer trends.
3.Possible store locations.
API Creators
What: API Call frequency,
payload sizes, Response Times
1.Improve frequently called APIs.
APP Developers
What: No of calls sent through App,
Locations where calls came from,
Types of Devices Used
1.Improve User Experience
2.Increase availability
on different platforms

17. What API Manager offers
Data gathering framework
●
●
●
Three streams – Request,Response and Fault
●
●
Works hand in hand with BAM,CEP
Can be extended to gather request payloads.
Data Analyzing Capabilities
●
Leverages BAM and CEP
●
BAM – Used for Analyzing Offline Data
●
CEP – Used for Analyzing and reacting in realtime.
●
Analyzing can be extended to achieve business specific requirements.

18. What API Manager offers...
●
Statistics Dashboard
●
●
No of subscriptions, No of Invocations, Response Times...
●
●
Displays Business Agnostic Stats by default
Displays Basic Usage Data
Google Analytics Handler
●
Useful for getting quick break down of Geographic Distributions, Devices being used

19. CEP – Demo
๏
Triggering Events when Delivery takes more
than a specified time.

20. Structure of Events
Default Event Stream
{
'name':'org_wso2_apimgt_statistics_request',
Custom Event Stream
{
'version':'1.0.0',
'name':'org_wso2_apimgt_custom_stream',
'nickName': 'API Manager Request Data',
'version':'1.0.0',
'description': 'Request Data',
'nickName': 'API Manager Open API Request Data',
'metaData':[
'description': 'Open API Request Data',
{'name':'clientType','type':'STRING'}
],
'payloadData':[
'payloadData':[
{'name':'context','type':'STRING'},
{'name':'consumerKey','type':'STRING'},
{'name':'context','type':'STRING'},
{'name':'api_version','type':'STRING'},
{'name':'api_version','type':'STRING'},
{'name':'resource','type':'STRING'},
{'name':'api','type':'STRING'},
{'name':'method','type':'STRING'},
{'name':'resource','type':'STRING'},
{'name':'method','type':'STRING'},
{'name':'name','type':'STRING'},
{'name':'version','type':'STRING'},
{'name':'version','type':'STRING'},
{'name':'request','type':'INT'},
{'name':'requestTime','type':'LONG'},
{'name':'requestTime','type':'LONG'},
{'name':'userId','type':'STRING'},
{'name':'requestId','type':'STRING'},
{'name':'tenantDomain','type':'STRING'},
{'name':'subscriber','type':'STRING'},
{'name':'hostName','type':'STRING'},
{'name':'clientAddress','type':'STRING'},
{'name':'apiPublisher','type':'STRING'},
{'name':'oderId','type':'STRING'}
{'name':'applicationName','type':'STRING'},
{'name':'applicationId','type':'STRING'}
]
}
]
}

21. Statistics Dashboard View

22. GA tracking
๏
Track API Calls like page visits
๏
API Resource Path is taken as the page.
๏
Show number of API calls against time.
๏
Useful for finding peak loads, frequently used days.
๏
Alternative platform for analyzing data.
๏
Web Applications can send the cookies along with API Calls
๏
Using _utmcc parameter, cookie details will be sent – This is
useful for tracking campaigns, previously visited sites, and
invoker details such as gender, age range.
๏
Useful for marketing campaigns – Which age group, gender
should be targetted.

23. GA – Geographical
Breakdown

24. GA- Device Wise
Breakdown

25. GA Usage
๏
Using GA Application Developers can
;
๏
Find out on which platform APIs are used most – Hence can improve User Experience on
those platforms.
๏
Indicate possible App markets – API may be used mostly on Android – but particular App
developer might not have developed an App for that platform.
๏
Considering the Geographical break down App developers can determine which
languages should be supported.
๏
API Creators can:
๏
Determine on which languages data should be made available.
๏
Test on mostly used platforms before rolling out changes/introducing new APIs.
๏
Business Owners can;
๏
Determine possible places to open up new stores.
๏
Introduce Regional Varieties.

26. Summary
๏
Usage of Operational Insights
– How to use BAM to track messages across different servers.
– How CEP is used to calculate response times in real time.
๏
Different Roles involved in an API
Ecosystem
๏
Using Google Analytics as a
complementary analytics tool
๏
Generating Insights from Statistics
Dashboad.

27. What WSO2 delivers

28. Business Model

29. Call to action page
๏
Include links to product downloads, white
paper downloads , etc.

32. Contact
us !