Diagnostics collection introduction

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

The diagnostic collection guides provide the following information:

  • Troubleshooting playbooks for common errors observed in Apigee Edge: Provides error codes and error messages that can be observed in Apigee Edge, and lists the corresponding playbooks which contain detailed steps to troubleshoot and resolve the errors.
  • Diagnostic information: Provides detailed steps to gather the diagnostic logs and the information required for troubleshooting the most common problems observed with Apigee Edge. Provides instructions on how to bundle the logs and information together to share with Google Cloud Apigee Edge Support in a Support case.

Prerequisites

On the machines where the Apigee Edge components are installed, ensure that you have the following:

  • Enough disk space in the /tmp directory to capture and store the diagnostic data
  • Required permissions to login and gather the diagnostic data

Guides

The following table describes the current Private Cloud diagnostic guides:

Private Cloud diagnostic guides

Analytics problems Provides details about the diagnostic logs and information required for Analytics problems such as data not showing up in the Analytics dashboard, custom reports, Postgres disk running out of space, and so on.
Cassandra problems Provides details about the diagnostic logs and information required for Cassandra problems.
Deployment errors Provides details about the diagnostic logs and information required for Deployment errors.
Runtime issues Provides details about the diagnostic logs and information required for errors, latency issues, or unexpected results observed during the execution of your API requests.
Unable to start Edge components Provides details about the diagnostic logs and information required for issues encountered while starting Apigee Edge components such as Router, Message Processor, Management Server, and ZooKeeper.
ZooKeeper problems Provides details about the diagnostic logs and information required for ZooKeeper problems.