Overview of API Monitoring

This page applies to Apigee and Apigee hybrid.

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.

About data retention: API Monitoring logs capture query parameter and user agent data. Since this data may contain personally identifiable information (PII), it is retained for 6 weeks, then deleted per the Google Privacy Policy. For more details, see Data retention.

Apigee hybrid users: Do not disable metrics in your hybrid configuration if you intend to view API Monitoring data. Metrics must be enabled in your hybrid configuration for API Monitoring data to show up. Metrics is enabled for hybrid by default.

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:

Note: There is a new version of the Apigee UI, which is integrated with the Google Cloud console. The new UI is called Apigee in Cloud console. The instructions in the first two tabs below explain how to use either Apigee in Cloud console or classic Apigee.

Apigee in Cloud console

1. Sign in to Apigee UI in Cloud console.
2. Select Proxy development > API monitoring.

Classic Apigee

1. Sign in to Apigee UI.

2. Select one of the following views:

   • Analyze > API Monitoring > Timeline
   • Analyze > API Monitoring > Investigate
   • Analyze > API Monitoring > Recent

This displays the main API Monitoring view. In the View menu, you can 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 describe these views in detail:

• Timeline
• Investigate
• Recent