Google Cloud Apigee monitoring integration

Monitor your Google Cloud Apigee resources to track API proxy traffic and latency, monitor target and upstream backend health, and keep an eye on security scores and anomalies. Google Cloud Apigee monitor lets you maintain a reliable and secure API management platform.

Benefits

Monitoring Apigee ensures that your API gateway remains reliable, secure, and high-performing. Key benefits include:

Identify latency spikes, error surges, or traffic anomalies before they impact end users.
Track response times, throughput, and back-end dependencies to fine-tune API delivery.
Automated alerts and IT automation help maintain SLA compliance and reduce downtime.
Consolidate Apigee metrics with other Google Cloud Platform (GCP) services for a single-pane-of-glass view.
Bulk configuration and agent upgrades ensure smooth monitoring across multiple API proxies.

Use cases

Here are some use cases where Google Cloud Apigee monitoring will be helpful:

Monitor average and percentile response times across proxies to detect bottlenecks in real time.
Capture 4xx/5xx error trends to quickly identify failing endpoints or misconfigured policies.
Visualize request volumes and peak usage periods to plan capacity and optimize scaling.
Set thresholds for availability and performance to ensure contractual obligations are met.
Track authentication failures, quota breaches, and policy enforcement metrics to strengthen API governance.
Integrate Apigee monitoring with other GCP services (Compute Engine, Cloud SQL, Kubernetes) for holistic visibility.

Setup and configuration

Adding Google Cloud Apigee while configuring a new Google Cloud monitor

If you have not configured a Google Cloud monitor yet, add one by following the steps below:
1. Go to Cloud > GCP > Add GCP Monitor or Admin > Cloud Monitoring > Google Cloud Platform(GCP).
2. Provide a unique display name for identification purposes.
3. Upload the JSON file that contains the private key of the service account to authenticate and perform resource discovery.
4. Select Apigee from the Select the Resources for Monitoring list.
5. Select existing Notification Profiles, User Alerts Groups, Tags, and IT Automation Templates or add new ones. You can also integrate alarms with your preferred third-party service.
6. Click Start GCP Monitoring.
Adding Google Cloud Apigee to an existing Google Cloud monitor

If you already have a Google Cloud monitor configured for the service account, you can add Google Cloud Apigee by following the steps below:
1. Go to Cloud > GCP and select your GCP monitor.
2. Click the hamburger icon next to Service View and select Edit, which brings you to the Edit GCP Monitor page.
3. On the Edit GCP Monitor page, select Apigee from the Select the Resources for Monitoring list and click Save.
4. After successful configuration, go to Cloud > GCP > Apigee. Now you can view the discovered Google Cloud Apigee resources.

Note

It takes approximately five minutes to discover new GCP resources.

Licensing

Each Google Cloud Apigee monitor consumes one basic monitor license.

Polling frequency

Google Cloud Apigee monitor collects minute-wise metric data, and the statuses of your Google Apigee resources are reported every five minutes.

Supported metrics

Metric name	Description	Statistic	Unit
API Hub Security Score	The security posture score computed for APIs registered in API hub.	Average	Count
Security Score	The overall security score computed for the Apigee organization based on detected risks.	Average	Count
Proxy Request Count	The number of requests received by an API proxy.	Total	Count
Proxy Response Count	The number of responses sent by an API proxy, grouped by response code.	Total	Count
Proxy Latencies	The latency distribution of requests processed by an API proxy.	Average	Milliseconds
Proxy Latencies Percentile	The latency distribution percentile for requests by an API proxy.	Average	Milliseconds
Target Request Count	The number of requests sent from an API proxy to its target back end.	Total	Count
Target Response Count	The number of responses received from the target back end, grouped by response code.	Total	Count
Target Latencies	The latency distribution of requests sent to the target back end.	Average	Milliseconds
Target Latencies Percentile	The percentile latency distribution of requests sent to the target back end.	Average	Milliseconds
Policy Latencies Percentile	The percentile latency distribution of policy execution within an API proxy.	Average	Milliseconds
Server Request Count	The number of requests received by the Apigee message processor.	Total	Count
Server Response Count	The number of responses sent by the Apigee message processor.	Total	Count
Server Fault Count	The number of faults encountered by the Apigee message processor while processing requests.	Total	Count
Server Latencies	The latency distribution of requests processed by the Apigee message processor.	Average	Milliseconds
Server Thread Count	The number of threads currently in use by the Apigee message processor.	Average	Count
Environment Active	Indicates whether the Apigee environment is currently active.	Average	Count
Environment API Call Count	The total number of API calls processed within an Apigee environment.	Total	Count
Environment Anomaly Count	The number of anomalies detected within an Apigee environment.	Total	Count
Environment Gateway Node Count	The number of gateway nodes provisioned for an Apigee environment.	Average	Count
Security Request Count	The number of requests evaluated by Apigee's advanced API security	Total	Count
Security Detected Request Count	The number of requests flagged with a security detection by Apigee's advanced API security.	Total	Count
Security Incident Request Count	The number of requests associated with a confirmed security incident.	Total	Count
Security Environment Score	The security score computed for an Apigee environment.	Average	Count
Security Proxy Score	The security score computed for an individual API proxy.	Average	Count
Upstream Request Count	The number of requests sent from the Apigee message processor to the upstream target.	Total	Count
Upstream Response Count	The number of responses received from the upstream target.	Total	Count
Upstream Latencies	The latency distribution of requests sent to the upstream target.	Average	Milliseconds
UDCA Disk Used Bytes	The amount of disk space used by the Universal Data Collection Agent (UDCA).	Average	Bytes
UDCA Upstream HTTP Error Count	The number of HTTP errors encountered by UDCA when communicating with its upstream endpoint.	Total	Count
UDCA Local File Count	The number of local files pending upload maintained by UDCA.	Average	Count
Monetization Request Count	The number of requests processed by Apigee's monetization module.	Total	Count
Monetization Latencies Percentile	The latency distribution percentile for requests processed by Apigee's monetization module.	Average	Milliseconds
Cassandra Client Request Latency	The latency of client requests made to the underlying Cassandra data store.	Average	Milliseconds
Cassandra Compaction Pending Tasks	The number of pending compaction tasks on the underlying Cassandra data store.	Average	Count

Threshold configuration

Global configuration
1. In the web client, go to the Admin section on the left navigation pane.
2. Select Configuration Profiles from the left pane and select Threshold and Availability from the drop-down menu.
3. Click Add Threshold Profile in the top-right corner.
4. For Monitor Type, select Apigee.
5. Specify the threshold values for the required metrics, then click Save.
Monitor-level configuration
1. In the web client, go to Cloud > GCP > Apigee.
2. Select a resource you would like to set a threshold for, then click the hamburger icon.
3. Select Edit, which directs you to the Edit Apigee Monitor page.
4. Specify the threshold values for the required metrics, then click Save.

IT Automation

IT Automation tools automatically resolve performance degradation issues. These tools react to events proactively rather than waiting for manual intervention. Automate repetitive tasks, like remediating threshold breaches. The alarm engine continually evaluates system events for which thresholds are set and executes the mapped automation when there is a breach.

How to configure IT Automation for a monitor

Configuration Rules

Editing multiple monitors to associate different monitor groups or add a different tag can be a tedious process. With Configuration Rules, you can automate the configuration settings of your monitoring resources. Create custom rules to track configuration changes continuously and achieve the ideal configuration settings.

How to add Configuration Rules

Summary

The Summary tab will give you the performance data organized by time for the metrics listed above. To view the summary:

Go to Cloud > GCP > Apigee.
Select a resource.
Click the Summary tab.

Configuration Details

The Configuration Details tab provides details on the configurations of application instances. To get the configuration details:

Go to Cloud > GCP > Apigee.
Select a resource.
Click the Configuration Details tab.

Reports

Gain in-depth data about the various parameters of your monitored resources and accentuate your service performance using our insightful reports.

To view reports for a Google Apigee resource:

Go to the Reports section on the left navigation pane.
Select Apigee from the menu on the left.
You can find the Availability Summary Report, Performance Report, and Inventory Report for one selected monitor. Or you can get the Summary Report, Availability Summary Report, Health Trend Report, and Performance Report for all the Google Apigee monitors.

You can also get reports from the Summary tab of the Google Apigee monitor:

Click the Summary tab.
Get the Availability Summary Report of the monitor by clicking Availability.
You can also find the Performance Report of the monitor by clicking any chart title.