Overview of API Monitoring

Stay organized with collections Save and categorize content based on your preferences.

You're viewing Apigee X documentation.
View Apigee Edge documentation.

After you build and launch your APIs on Apigee, you need to ensure that they are available and performing as expected in order to maintain uninterrupted service. Apigee's API Monitoring enables you to track your APIs to make sure they are up and running correctly. API Monitoring provides near real-time insights into API traffic and performance, to help you quickly diagnose and solve issues as they arise.

API Monitoring enables you to:

  • Create alerts to notify you of changes in API traffic so you can take appropriate action before customers are affected.
  • Increase API availability and reduce the mean-time-to-diagnosis (MTTD) by quickly investigating issues with your APIs.
  • Leverage fault codes to speed diagnosis.
  • Isolate problem areas quickly to diagnose errors, performance, and latency issues and their source.

As an Apigee customer, you can also use Cloud Monitoring tools to support API Monitoring.

Video: Check out this short video for an overview of API Monitoring.

API Monitoring roles

To access API Monitoring, you need to be assigned the following roles:

  • roles/apigee.readOnlyAdmin
  • roles/monitoring.viewer

See Apigee roles for more information about what roles are appropriate for using API Monitoring.

Accessing API Monitoring

You can access API Monitoring through the Apigee UI by doing the following steps:

  1. Sign in to Apigee UI.
  2. Switch to the organization that you want to monitor.
  3. Select Analyze > API Monitoring. The submenu displays links to the two main views in the UI, as shown below.
    Select the UI view.
    To access the UI, select one of the following views:
    • Timeline: Displays timelines of recent API traffic data.
    • Investigate: Displays tables of API traffic data, such as fault code by region.
    • Recent: Displays treemaps of data in which each proxy is represented by a rectangle, whose size is proportional to the amount of API traffic for the proxy, and whose color denotes the relative size of related metrics.

The following sections describes these views in detail: