Happy Business Starts Here

API Timeouts and Performance

Highlighted
Zuora Alumni

API Timeouts and Performance

Troubleshooting API related issues is challenging and may require a joint effort between the calling and receiving ends to identify and determine appropriate steps for resolution.

 

 



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

1 ACCEPTED SOLUTION

Accepted Solutions
Highlighted
Zuora Alumni

Re: API Timeouts and Performance

Troubleshooting

 

First determine which type of error it is, it's origin, and don't rule out the possibility that more than one issue could be occurring simultaneously.

 

If there are more than one issue present, troubleshoot each separately before trying to tie any correlation as to a common root cause.

 

  • Timeout
  • Connection
  • Latency
  • Server side errors
  • Client side errors

 

Timeouts

 

Determine whether it is the client, or server side, that is timing out

 

Timeouts can occur in clients due to:

 

  • connection not established after N number of seconds - see Troubleshooting Connection Issues (below)
  • long lived connections
  • no data received after N number of milliseconds/seconds
  • custom code to kill/close a connection

 

Connection Issues

 

Connection issues are those where a (TCP) connection can not be established, or is closed unexpectedly by either the client or server.

 

TCP/Connection issues will generally be treated as exceptions/faults by the client, the details of which will usually include a stack trace, or other trace information showing where in the client code, the error originated

 

Some of the tools/methods to obtain more detail on the nature of the Connection issue are as follows:

 

 

 

If these tests show that no connection is being established with any host within Zuora's public IP range, then this is a connection issue.

 

You can check the current publically accessible IP's and ranges here : Inbound_and_Outbound_IP_Addresses

 

If you do see a connection being made, continue analyzing other possibilities

 

 

Errors that return a code/message

 

 

Latency, slow response, taking longer than usual

 

 

 

Resolution

 

Client Side

 

The following issues can should be addressed on the client side

 

 

Server Side

 

For Issues not resolvable on the client / calling side

 

 

Additional Reference

 

 



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

View solution in original post

1 REPLY 1
Highlighted
Zuora Alumni

Re: API Timeouts and Performance

Troubleshooting

 

First determine which type of error it is, it's origin, and don't rule out the possibility that more than one issue could be occurring simultaneously.

 

If there are more than one issue present, troubleshoot each separately before trying to tie any correlation as to a common root cause.

 

  • Timeout
  • Connection
  • Latency
  • Server side errors
  • Client side errors

 

Timeouts

 

Determine whether it is the client, or server side, that is timing out

 

Timeouts can occur in clients due to:

 

  • connection not established after N number of seconds - see Troubleshooting Connection Issues (below)
  • long lived connections
  • no data received after N number of milliseconds/seconds
  • custom code to kill/close a connection

 

Connection Issues

 

Connection issues are those where a (TCP) connection can not be established, or is closed unexpectedly by either the client or server.

 

TCP/Connection issues will generally be treated as exceptions/faults by the client, the details of which will usually include a stack trace, or other trace information showing where in the client code, the error originated

 

Some of the tools/methods to obtain more detail on the nature of the Connection issue are as follows:

 

 

 

If these tests show that no connection is being established with any host within Zuora's public IP range, then this is a connection issue.

 

You can check the current publically accessible IP's and ranges here : Inbound_and_Outbound_IP_Addresses

 

If you do see a connection being made, continue analyzing other possibilities

 

 

Errors that return a code/message

 

 

Latency, slow response, taking longer than usual

 

 

 

Resolution

 

Client Side

 

The following issues can should be addressed on the client side

 

 

Server Side

 

For Issues not resolvable on the client / calling side

 

 

Additional Reference

 

 



If you found my answer helpful, please give me a kudo ↑
Help others find answers faster by accepting my post as a solution √

View solution in original post