Manage Support Logs

You can gather system logs about your API gateway, which are then compressed into a support bundle file (log-data.tar.gz) and stored in a destination directory that you specify. You can send the support bundle to Quantum support to help diagnose any issues or failures you might encounter with your system.

The support bundle file contains logs for each running quantum-api docker container, postgress dumps for endpoint and Kong databases, and a docker-ps.txt file that contains a list of all docker containers.

Note: For a list of all the API gateway commands, see API Gateway (APIGW) Command Index.

Do the following to gather system logs and create a support bundle file:

  1. Open an SSH connection to the API gateway and log in.
  2. At the prompt, enter the following:

    3. opt/quantum/api-gateway/bin/apigw gather <destination directory>

    Note: The destination directory is directory where you want to store the support bundle file.

  3. Below is an example of the output:

    4. Saving 4fb0064c2cd5 container logs to /root/data/quantum-api_rest-aggregator-usbe-hosts.1.8vhi8a3zam756ll311bsp1pwy.log
Saving 57fffa4e1345 container logs to /root/data/quantum-api_rest-aggregator-xwd-hosts.1.g87pjl7hlu3oh1fqvp4rq0f8g.log
Saving 29143252d917 container logs to /root/data/quantum-api_keycloak-server.1.dhug1shfvsyvhm7d0ai2vdz3i.log
Saving ec7093c0a595 container logs to /root/data/quantum-api_rest-aggregator-qxs-hosts.1.y0f9h9ck89oet5bs7a9j73bs9.log
Saving 9560536254fb container logs to /root/data/quantum-api_kong-server.1.2z11o52cxuge1mq3vig845m5g.log
Saving fb1db75fbb46 container logs to /root/data/quantum-api_rest-aggregator-appliance-controller-hosts.1.fcfbwih5dp8v9e8cpog9wtab9.log
Saving 045fffeebdae container logs to /root/data/quantum-api_rest-aggregator-flexsync-hosts.1.tp54auw4tekc14qwu3m28hmpf.log
Saving 570c2847748c container logs to /root/data/quantum-api_rest-aggregator-usbe-qxs-proxies.1.iivau6x8yfac599nbqjv87i01.log
Saving 4f22be337813 container logs to /root/data/quantum-api_rest-aggregator-name-servers.1.2cqx1j41vsfrz4uow75ym8491.log
Saving b409e2051420 container logs to /root/data/quantum-api_rest-aggregator-scalar-hosts.1.p3crjbil7y7o4xym3huqqktkt.log
Saving f9f81b174134 container logs to /root/data/quantum-api_rest-aggregator-hseries-hosts.1.2dt92q5l729ctmzw5tcv4dcfy.log
Saving b4c530d74add container logs to /root/data/quantum-api_kong-database.1.tsizrdw3oqyvow7cekwq45212.log
Saving 7fac184c6683 container logs to /root/data/quantum-api_rest-aggregator-fseries-hosts.1.y34ujsrr11b8d86ws4k2mktuz.log
Saving be274964a5d0 container logs to /root/data/quantum-api_gateway-admin-api.1.cyq8ij3y4t9a9oa2h6ko1ruvp.log
Saving 42fe1a4c6d89 container logs to /root/data/quantum-api_rest-templates.1.jf31u1qnkycoaam6t6dci9vze.log
Saving d1b3009b7372 container logs to /root/data/quantum-api_rest-aggregator-activescale-hosts.1.8dt418i7kitmzr8vithgrjfil.log
Saving 9299fc7ee454 container logs to /root/data/quantum-api_rest-aggregator-hosts.1.unlu4pi87ztfzjc7nqsftvii0.log
Saving 7faf5f1b425d container logs to /root/data/quantum-api_keycloak-database.1.dat7icrecplvifgerwtgp0z29.log
Saving 1fcde362aa1c container logs to /root/data/quantum-api_rest-fs-create.1.jy7fjnuwvmp6iepg2s2x2icqp.log
Saving 1f4f77258fee container logs to /root/data/quantum-api_rest-aggregator-pseries-hosts.1.nzvo02iv2fdzf157u30dkp1xt.log
Saving 5c12b7e5ac12 container logs to /root/data/quantum-api_rest-aggregator-xwe-hosts.1.6sgd50j39xbty65megw14yo4x.log
Saving fbb0a198fe98 container logs to /root/data/quantum-api_rest-aggregator-datamovers.1.j05rwlzk7hv4naifrmaho2rfq.log
Saving 6ddcdccd0de9 container logs to /root/data/quantum-api_license-sender.1.1x6g3yef5f6hsa3vndhdyw6ac.log
Saving ebedcf48765b container logs to /root/data/quantum-api_endpoint-database.1.i4qqvo68oramkcydi4oe7umv0.log
Saving ae03d3fb8126 container logs to /root/data/quantum-api_rest-aggregator-filesystems.1.yx02y1xcdotbv8mbomohra9cv.log
Saving 5863bf33630c container logs to /root/data/quantum-api_rest-registrar.1.ez5p891jbnr00x68w6vq0v06b.log
Saving 8bae5958d0b9 container logs to /root/data/quantum-api_license-aggregator.1.ykxnedsqb53ydz9p0izsu8779.log
Saving b385ee81ce45 container logs to /root/data/quantum-api_rest-aggregator-metadata-controllers.1.jnofynkgz0mr2ouutqofm286n.log
Saving ebedcf48765b container postress dumps to /root/data/quantum-api_endpoint-database.1.i4qqvo68oramkcydi4oe7umv0.out

Saving b4c530d74add container postress dumps to /root/data/quantum-api_kong-database.1.tsizrdw3oqyvow7cekwq45212.out

Saving docker container info to /root/data/docker-ps.txt
Compressing /root/data to /root/log-data.tar.gz
~ ~
~
Removing /root/data