Out-of-the-box Analytics

SaaS On-premises 2.0
By the end of this tutorial, you will be able to find visual information on an application's traffic.

Each application using an API has a traffic trace in the 3scale system, which can be viewed from the Admin Portal as well as recovered by an API.

Step 1: Find the application

You can find the application from the Developers or Applications tabs or by searching as described in the finding applications tutorial.

Step 2: Understand the application display

Once you've located the application, you'll see an overview screen with information about the application as shown in the following image.

The items labeled in the diagram correspond to the following information:

  1. The name of the application given by the developer.
  2. Meta data captured for the application (learn how to set which data to capture in the advanced section).
  3. The status of the application – is it live or suspended?
  4. The current API identifiers, keys, and certificates that the application has. (This view varies depending on what authentication method was used to integrate the API into 3scale).
  5. A summary of traffic statistics for the application.
  6. Information on which application plan the application is on and which rate limits apply.

Step 3: Use the menu to access the full screen statistics view

On the screen shown in the screenshot above, you will find a breadcrumb like this on top of the app's name: "Account 'account' > Application 'application name' > Analytics | API Request Log". Click on Analytics. This will take you to the usage charts view for the application as shown in the image below.

Controlling the metrics, methods, and time range allows you to check different types of data about the application.

Step 4: See the traffic log (Enterprise plans only)

If request logging is enabled, clicking on the "request logs" menu item shows the latest logged transactions for the application. These may be all transactions or a subset (such as errors) depending on configuration.

If you're using APIcast 2.0 and OpenShift, you can enable/disable the request logs feature with the APICAST_REQUEST_LOGS parameter provided by the OpenShift template. You can do so editing the template directly, or in the GUI:

  1. Log into your OpenShift console.
  2. Go to Applications > Environments and click on your API gateway.
  3. Click on Environment.
  4. Edit the APICAST_REQUEST_LOGS variable: Set it to 'true' if you want request logs enabled, to 'false' if you want them disabled.