IBM Support

Collect MustGather data for IBM API Connect MicroGateway

Troubleshooting


Problem

Gather the following MustGather information for IBM Support to use in troubleshooting problems with the IBM API Connect (APIC) MicroGateway.

Resolving The Problem

The following information describes the basic documentation needed by IBM support to investigate questions or problems when using IBM API Connect MicroGateway.

Please DO NOT send any confidential information from your company.

If not yet done, please provide the information requested in the General MustGather to help IBM Support to collect all the data necessary to troubleshoot your problem. This will expedite problem resolution.

General MustGather
Gathering general problem description information


In addition, please provide the information requested below, when applicable to your issue, to complete the data collection necessary to troubleshoot your problem.


Versions of the following components installed on your machine
Use the corresponding command to get the exact version installed on your system.

  • node js (node -v / node --version)
  • npm (npm -v / npm --version)
  • apic (apic --ext-version or apic -v / apic --version)

Enable Debug
Please follow these steps:


    1. Go to /home/user/.apiconnect folder and check if logger-config.js file is available

    2. If the logger-config.js file is not available, create the file with the following code:

    <home>/.apiconnect$ cat logger-config.js
    module.exports =
    {
    bunyan: {
    name: 'userConnect',
    streams: [{
    level: 'debug',
    type: 'file',
    path: 'custom_file.log'
    }]
    },
    filelogger: {
    file: 'custom.log',
    size: '50M',
    keep: 10
    }
    };

    3. New requests to the microgateway will now write log entries into the custom_file.log file

    4. Recreate the issue and send us the following files :
    • APIC Log: ~/.apiconnect/apic.log
    • MGW Debug Log: ~/.apiconnect/custom_file.log
    • Project config: $PROJECT_DIR/.apiconnect/config
    • Global config: ~/.apiconnect/config
    • Strong PM log: ~/.apiconnect/strong-pm/start.log


    How to submit diagnostic data to IBM Support

    After you have collected the preceding information, and the support ticket is opened, you can exchanging information with IBM Technical Support for problem determination.

    For more details see submit diagnostic data to IBM (ECuRep) and Enhanced Customer Data Repository (ECuRep) secure upload.



    If you are using Service Request (SR), update the problem record to indicate that data has been sent.



[{"Product":{"code":"SSMNED","label":"IBM API Connect"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"--","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"5.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
15 June 2018

UID

swg22006449