IBM Support

MustGather: Rate Limiting Issues on DataPower Gateways and API Connect

Troubleshooting


Problem

The following information is required for IBM Support to utilize when troubleshooting rate limiting issues with DataPower Gateway and API Connect. 

Symptom

IBM DataPower Gateways and API Connect configurations may show signs of the following behavior when experiencing Rate-Limiting issues:
 ⇒If unexpected throttling occurs
⇒SLM warnings/SLM Peering is not operating properly 
⇒Quota Enforcement configuration is not working or synching properly
⇒WebAPI Rate-limit plan and monitor issues

Resolving The Problem

IBM Support Team requires the following documentation to investigate questions or unexpected behavior encountered using Rate-Limiting with IBM DataPower Gateway and API Connect. Please ONLY collect data from the product below which you are experiencing this behavior on.

  • - DATAPOWER GATEWAYS

    Step 1: Gather information of the current appliance environment status.
    Please copy/paste the following questions and provide the answers found below:
       1.  What protocol feature are you using for rate limiting? SLM policy? SLM Peering? QE? etc.
       2.  How many appliances are in your peer group? Are you using Unicast or Multicast?
       3.  What is the actual behavior and expected behavior you are seeing?
       4.  What is the object name/ policy name which you see the issue?
       5.  Is this issue intermittent or consistent? Can this behavior be recreated? If yes, please list the recreate steps.
       6.  Have there been any changes made in the environment (DataPower, APIC, network, firewalls, load balancers, etc.)?
       7.  Can you verify that the SLM/Rate-limiting policy config is identical?

    Step 2: Collect an export of the domain.
    https://www.ibm.com/docs/en/datapower-gateway/10.5.0?topic=export-backing-up-domains
     

    Step 3: Set Error Report to debug level.
    Control Panel -> Troubleshooting -> Logging -> Log Level = Debug -> Set Log Level

    Step 4: Recreate your problem.
    Reproduce the same steps previously used which resulted in the irregular behavior.

    Step 5: Generate and download the Error Report.
    After setting your log level to debug and recreating the behavior, your error report will include debug transactions of the behavior. Collect the error report by selecting "generate error report" under the Troubleshooting section. 
    https://www.ibm.com/docs/en/datapower-gateway/10.5.0?topic=reports-generating-error

    Step 6: Contact and send your MustGather data to IBM Support: 
    In your created case with IBM Support(Product= DataPower), please create a detailed problem description including the information collected in steps 1-5 above. Which include:
       1.  Current environment status
       2.  The domain export
       3.  Error report on debug level
    Provide any additional details of internal or external events which occurred when recreating the issue.
    ► Note: Include any error messages, log records, screen captures, or other interesting facts that would help explain the irregular behavior. 

  • - API CONNECT

    Step 1: Gather information of the current state of the appliance in your environment.
    Please copy/paste the following questions and provide the answers found below:
       1.  How many gateways are in the cluster? List all APIs that are affected.
       2.   What kind of thresholds are you trying to cater to?
       3.   What is the expected load / throughput in the environment?
       4.   What is the expected behavior and actual behavior of the rate limiting policy? 
       5.   Is this issue intermittent, or consistent? How are you testing or reproducing this issue (please provide exact steps)?
       6.  Around what timestamp was this reproduced and captured in the data?
       7.   Have there been any changes made in the environment (DataPower, APIC, network, firewalls, load balancers, etc.)?
    Note►If applicable, provide details of any internal or external events which occurred when observing and or recreating the problem. Include any error messages, log records, screen captures, exceptions, faults, or other pertinent facts which could contribute to the irregular behavior.

    Step 2: Retrieve the Analytics Report/Export
    https://www.ibm.com/support/knowledgecenter/en/SSMNED_5.0.0/com.ibm.apic.apionprem.doc/tapim_analytics_exportanalyticsdata.html

    Step 3: Download the export YAML file.
    ►  Version 5.0.x
    ►  Version 2018.x

    Step 4: Gather postmortem data and logs.
    This data is essential when analyzing queues and process stacks.

    Management server Postmortem logs can be generated from the CLI : 
    Example:
           debug postmortem generate fulllogs
       debug postmortem export

    To complete this action from the GUI please follow direct instructions here: https://www.ibm.com/support/knowledgecenter/en/SSMNED_5.0.0/com.ibm.apic.cmc.doc/node_post.html

    Step 5: Contact and send your MustGather data to IBM Support: 
    In your created case with IBM Support (Product= API Connect), please create a detailed problem description including the information collected in steps 1-4 above. Which include:
       1.  Current environment status
       2.  Analytics Report/Export
       3.  YAML
       4.  Postmortem Logs
       

[{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SS9H2Y","label":"IBM DataPower Gateway"},"Component":"Rate Limiting;API Connect;API Management;IBM DataPower Gateway","Platform":[{"code":"PF009","label":"Firmware"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB67","label":"IT Automation \u0026 App Modernization"}},{"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSMNED","label":"IBM API Connect"},"Component":"Rate Limiting;API Connect;API Management;IBM DataPower Gateway","Platform":[{"code":"PF009","label":"Firmware"}],"Version":"All Versions","Edition":"","Line of Business":{"code":"LOB67","label":"IT Automation \u0026 App Modernization"}}]

Document Information

Modified date:
16 February 2024

UID

ibm10734755

Page Feedback