Debug, analytics, and deployment status data collection

You are currently viewing version 1.6 of the Apigee hybrid documentation. This version is end of life. You should upgrade to a newer version. For more information, see Supported versions.

Version 1.6 (unsupported)

   Supported versions:

• v1.13 (latest)                        
• v1.12                         
• v1.11                         
• List of supported versions

   Unsupported versions:

• v1.10                                      
• v1.9                                         
• v1.8                                         
• v1.7                                         
• v1.6                                         
• v1.5                                         
• v1.4                                         
• v1.3                                         
• v1.2                                         
• v1.1                                         

Apigee hybrid makes debug, analytics, and deployment status data available to you. This data is collected by a data collection pod which sends it to the management plane 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 via TCP to a data collection pod in the cluster. The data collection pod stores the streamed data on the pod's file system via a fluentd service.

The UDCA (Universal Data Collection Agent) periodically extracts the stored data and sends it to the UAP (Unified Analytics Platform) service in the management plane. The UAP processes the incoming analytics and deployment status data and makes it available to you via the hybrid UI or the Apigee APIs.

Apigee hybrid implements the data collection pod as a ReplicaSet with a minimum of two replicas.

The following image shows the debug, analytics, and deployment status data collection process:

Note that 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 by the data collection pod:

Type of Data	Dataset Name	Description	Update Frequency	APIs
Analytics	api	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	event	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	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

TIP: The dataset name is the name by which this type of data is referred to in the UDCA configuration properties. For example, analytics data is configured with the dataset name api. As a result, the configuration property that sets the location of the analytics data files is called apiDataSubDir.

You can access this data through the Apigee hybrid UI or Apigee APIs on the management plane.

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

To set how and where debug, analytics, and deployment status data is collected on the data collection pod, you configure the UDCA service via its configuration properties. The UDCA properties include properties that are general to the UDCA as well as properties that are specific to each dataset.

To configure the UDCA:

1. Open the overrides.yaml file for editing on your Kubernetes administration machine, as described in Manage runtime plane components.
2. Set the values of the UDCA configuration settings. For the UDCA, you can set custom values for properties such as:
   • Polling interval
   • Number of replicas (min and max)
   • Target CPU percentage (that triggers additional replicas)

   For a complete list of UDCA properties that you can customize, see udca.

3. Save your changes to the overrides.yaml file.
4. Apply your changes to your cluster by executing the apigeectl apply command, as the following example shows:

   apigeectl apply -f my-overrides.yaml --org --env env-name

   TIP: To see the default configuration properties, the UDCA service (under udca:) in the Configuration property reference.

   For more information about the apply command, see Apply the cluster configuration.