Introduction to Apigee X and Apigee hybrid playbooks

You're viewing Apigee X documentation.
View Apigee Edge documentation.

The act of troubleshooting is both an art and a science. The constant effort of Apigee technical support teams has been to demystify the art and expose the science behind problem identification and resolution.

What are playbooks?

Developed in collaboration with Apigee Technical Support teams, Apigee troubleshooting playbooks are designed to provide quick and effective solutions to errors or other issues that you may encounter when working with Apigee products.

To find troubleshooting playbooks, you can try searching for specific error messages using the Search box at the top of this page, or use the TOC on the left to navigate the playbook library.

Audience

Troubleshooting playbooks are intended for readers with a high-level understanding of Apigee and its architecture, as well as some understanding of basic concepts such as policies and analytics.

Some problems can be diagnosed and solved only by Apigee hybrid users and may require knowledge of internal components such such as Cassandra and Postgres datastores, Message Processors, and Routers.

If you are on Apigee X, then we clearly specify when you can perform the indicated troubleshooting steps and when you need to contact Apigee Support for assistance.

Playbooks

The following table describes the current playbooks:

Cassandra

Playbook/Problem description Error message Playbook applicable for
Cassandra pods not starting in the secondary region Cassandra pods fail to start in one of the regions in a multi-region Apigee hybrid setup. You may see a node already exists error message in the Cassandra pod logs, or a FailedPreStopHook warning in the Cassandra pod status. Apigee hybrid users only

Deployment

Playbook/Problem description Error message Playbook applicable for
API proxy deployments fail with no active runtime pods warning The No active runtime pods warning is displayed in the Details dialog next to the error message Deployment issues on ENVIRONMENT: REVISION_NUMBER on the API proxy page. Apigee hybrid users only

Ingressgateway

Playbook/Problem description Error message Playbook applicable for
API calls fail with timeout errors

curl: (7) Failed to connect to example.apis.com port 443: Operation timed out
Apigee hybrid users only
API Calls failing with TLS errors

curl: (35) LibreSSL SSL_connect: SSL_ERROR_SYSCALL in connection to example.apis.com:443
Apigee hybrid users only

Management/UI

Playbook/Problem description Error message Playbook applicable for
Inconsistent/no data observed for entities in hybrid UI or through Management APIs No error messages are known to be shown in this scenario. Apigee hybrid users only