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.
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:
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:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-10 UTC."],[[["This page covers API Monitoring for both Apigee and Apigee hybrid, enabling users to track API performance and availability."],["API Monitoring provides near real-time insights into API traffic and performance, allowing users to diagnose and resolve issues promptly, create alerts, and reduce mean-time-to-diagnosis."],["API Monitoring data, including query parameters and user agent information, is retained for six weeks before being deleted in accordance with Google's Privacy Policy."],["Accessing API Monitoring is available through either the Apigee UI in Cloud console or the classic Apigee UI, providing options to view timelines, investigate issues, or examine recent data."],["To use API Monitoring, users need the `roles/apigee.readOnlyAdmin` and `roles/monitoring.viewer` roles, and Apigee hybrid users must have metrics enabled in their hybrid configuration."]]],[]]