How can I get debug information for Polyspace Access running in Kubernetes?

When experiencing an issue with Polyspace Access installed in a Kubernetes cluster, how do I generate logs or reports that I can send to MathWorks Support to help diagnose the issue?

Answer 1

[MathWorks Support Team]

You can generate and send the Polyspace Access service logs to MathWorks Support to help diagnose a Polyspace Access issue, be it an issue related to uploads, downloads, or performance. To do that, use the access_k8s_debug tool attached to this article to generate a zipped folder that contains the logs and other output files.

Important: the script should be launched just after the issue is faced. Ideally, restart the Polyspace Access instance, reproduce the problem then launch the script just after. The idea is to ensure that the logs capture the error messages.

This script can be used with Polyspace Access version R2024a and later.

1. Before you launch the script, activate the Polyspace Access debug mode to create logs with a more verbose output. To activate the debug mode, use URL: "http(s)://FQDN:port/setdebugmode/on", where "FQDN" is the Fully Qualified Domain Name of your Polyspace Access server. For example, https://example.access.server:9443/setdebugmode/on
2. Then reproduce your issue. For instance, if it is an upload issue, you can execute upload again with option -log cli.txt (polyspace-access -log cli.txt -upload...). Then you will attach cli.txt with the zip file generated by this script.
3. As soon as the issue has been reproduced, use the attached script on this page. The script usage is as follows:
   • Connect to the server where you installed Polyspace Access and open a shell session.
   • Unzip the file access_k8s_debug.zip (attached to this post) in the folder where the Polyspace Access is installed (the folder containing the values.yaml file)
   • In the folder where you unzipped the file, set the appropriate execution rights for the script access_k8s_debug.sh by running the command below:
     • chmod u+x access_k8s_debug.sh
4. Then execute the script and specify the namespace of the cluster as the unique argument.
   • Example: sudo ./access_k8s_debug.sh my_cluster
5. This will create a file named all_info_k8s_<date>.zip. Attach this zip file to your service request.
6. Deactivate debug mode: http(s)://FQDN:port/setdebugmode/off

Note: The generated logs might contain names of projects that you uploaded to Polyspace Access.