Debug, analytics, and deployment status data collection

Apigee hybrid makes debug, analytics, and deployment status data available to you. This data is sent from the runtime components directly to the management plane via a Google Cloud Pub/Sub-based data pipeline so that you can view and analyze it and set up monitoring and alerts.

About the data

All Message Processor (MP) services in hybrid stream debug (when initiated), analytics, and deployment status data directly to the Apigee control plane using Google Cloud Pub/Sub.

The UAP (Unified Analytics Platform) service in the management plane processes the incoming analytics and deployment status data and makes it available to you via the hybrid UI or the Apigee APIs.

The debug, analytics, and deployment status data is not stored in the same location or accessed in the same way as the logging and metrics data:

  • Logging and metrics data are stored on your Google Cloud Project and accessed via a tool such as Cloud Operations or whatever you choose to use.
  • Debug, analytics and deployment status data, on the other hand, is stored in the hybrid management plane and you access it via Apigee services such as the hybrid UI or Apigee APIs.

The following table summarizes the data collected:

Type of Data Description Update Frequency APIs
Analytics API usage data including transactions per second, cache usage, errors, latencies, request/response sizes, and traffic counts.

For more information, see Apigee Analytics overview.

Up to 30 second delay Analytics admin API
Deployment Status The current deployment status of the API proxy.

For more information about how you can see this information, see View deployment status.

Immediately Deployments API
Debug

Debug session data for API proxies. This data includes the request/response parameters along with transformations applied to them at policy execution time.

Because of its size, debug data—unlike analytics and deployment status data—is not collected all the time. Instead, debug data is collected when you initiate a debug session.

For more information, see Debug overview.

Immediately Debug session API
Debug session data API

View the data in the hybrid UI

This section describes how to view the debug, analytics, and deployment status data in the Apigee hybrid UI.

Debug

Debug data for hybrid services is accessible in the same way as Edge debug data, with some differences such as increased filter support. For more information, see Debug overview.

Analytics

Analytics data for hybrid services is accessible in the same way as Edge analytics data. For more information, see Using the analytics dashboards in the Edge documentation.

Proxy deployment status

For information on viewing deployment status, see View deployment status.

Configure the data collection

The Pub/Sub-based data pipeline is enabled by default. You must ensure that your service accounts are properly configured with control plane access, as described in Step 8: Enable control plane access.