Analytics
Last updated: 2 minutes read.
The Tyk Dashboard has a full set of analytics functions and graphs that you can use to segment and view your API traffic and activity. The Dashboard offers a great way for you to debug your APIs and quickly pin down where errors might be cropping up and for what clients.
Tyk has two types of analytics:
- Per request. Per request statistics contains information about each request, like path or status. It is also possible to enable “detailed request logging” where it will log base64 encoded data.
- Aggregate. Aggregate statistics, aggregated by hour are available for the following keys:
APIID,ResponseCode,APIVersion,APIKey,OauthID,Geo,TagsandTrackPath.
Note
In Tyk v5.1 (and LTS patches v4.0.14 and v5.0.3) we introduced User Owned Analytics which can be used to limit the visibility of aggregate statistics to users when API Ownership is enabled. Due to the way that the analytics data are aggregated, not all statistics can be filtered by API and so may be inaccessible to users with the Owned Analytics permission.
How ?
When you make a request to the Tyk Gateway, it creates analytics records and stores them in a temporary Redis list, which is synced (and then flushed) every 10 seconds by the Tyk Pump. The Pump processes all synced analytic records, and forwards them to configured pumps. By default, to make the Tyk Dashboard work, there are 2 pumps depending on your database platform:
mongo (per request) and mongo_aggregate (for aggregate).
sql (per request) and sql_aggregate (for aggregate)