How can I get debug information for Polyspace Access?

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

Answer 1

[MathWorks Support Team]

Use access_debug.sh to collect Polyspace Access logs and diagnostic information for MathWorks Support.

The current script supports Cluster Admin Agent deployments from R2019a through R2027a, and Docker Compose deployments from R2026a. Kubernetes collection is included but is not officially supported.

Here is how to use it:

• 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
• 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 all_info.zip.
• As soon as the issue has been reproduced, use the script. The script usage is as follows:
  • Connect to the server where you installed Polyspace Access and open a shell session.
  • Unzip the file access_debug_v<version>.zip, set the appropriate execution rights for the script access_debug.sh by running the command below: chmod u+x access_debug.sh

Run the script from the directory that matches your deployment:

• Cluster Admin Agent: The Polyspace Access installation directory containing VERSION and settings.json.
• Docker Compose: The active deployment directory containing .env and the Compose file, such as docker-compose.yaml. The script exits if .env or the Compose file is missing.
• Kubernetes: Any directory, provided kubectl is configured for the target cluster.
  • The script will ask you the deployment platform (Cluster Admin Agent, Docker Compose or Kubernetes).

• • You can also specify the option -p to directly generate the logs for a deployment platform:
    • ./access_debug.sh -p cluster-admin-agent
    • ./access_debug.sh -p docker-compose
    • ./access_debug.sh -p kubernetes (the optional positional argument -n can be used for the namespace)
  • The script will then create a file named all_info_<deployment>_<date>.zip. Attach this zip file to your service request.
• Deactivate debug mode: http(s)://<FQDN>:<port>/setdebugmode/off

Note: The generated logs might contain names of projects that you uploaded to Polyspace Access. A copy of settings.json is done where the passwords have been removed.