Troubleshooting for the JetBrains plugin
Last updated
Last updated
More information
Snyk privacy policy© 2024 Snyk Limited | All product and company names and logos are trademarks of their respective owners.
Snyk plugins are not supported on any operating system that has reached End Of Life (EOL) with the distributor.
Each JetBrains IDE provides easy access to the logs.
Follow these steps to set logging to the debug level.
To obtain plugin logs, navigate to Help > Show Log in Finder (Mac) or Show Log in Explorer (Windows).
You can change the log level to debug using the IDE:
Press Shift Shift quickly and select the tab Actions . Then search for debug . Alternatively, select the debug log settings in the menu (not available in Jetbrains Rider).
Snyk Code enables normal debug logging (only until plugin version 2.6.0).
Snyk CodeRequestLogging enables a detailed protocol of the HTTP requests when communicating with the Snyk Code API (only until plugin version 2.6.0).
Snyk Language Server enables debug logging of the language server in the background.
Refer to the JetBrains documentation on how the IDE resolves custom certificates and how to import them if the plugin experiences any network failures due to incorrect configuration.
Sometimes the checkboxes for Snyk Code in the JetBrains IntelliJ plugin are disabled. Some possible reasons follow:
Network or proxy settings: If the network or proxy settings are not configured correctly, the checkboxes may be disabled. Check to see if there is an MITM proxy with certificate substitution. Also, verify whether connections to the endpoint API and deeproxy can be established using other tools, for example, the CLI or cURL.
Incorrect endpoint address: If the endpoint address in the Snyk Code plugin configuration is incorrect, the checkboxes will be disabled. To fix this, check that the endpoint address is correct by following the instructions. Restart IntelliJ afterwards.
Snyk Code is disabled server-side: If Snyk Code is disabled in the Snyk Organisation's settings, the checkboxes will be disabled. To fix this, follow the instructions shown in the IntelliJ settings. Restart your IDE.
Have a look at the JetBrains logs: For additional information, see Locating IDE log files.
Snyk uses Python in order to scan and find your dependencies.
If you are using multiple Python versions, use the --command option to specify the correct Python command for execution. The plugin does not detect the Python version associated with the Project.
The JetBrains plugin scans your Kubernetes workload files and collects the images used. To troubleshoot whether the plugin is correctly scanning a container image, you can verify the following:
Whether the image definition is in the Kubernetes YAML file in the Project. Ensure you have the image specified with an image name mapped in the format imageValue:imageKey for the image yaml attribute, for example, image:nginx:1.17.1.
Whether the container image has been successfully built locally or pushed to a container registry or both. It is also a good practice to verify this before referring to the container image in the Kubernetes YAML file.
If you encounter an error contact support.
For each image found, perform a test with the Snyk CLI.
For more information about how Snyk Container performs a test on the image, Refer to Snyk CLI for Snyk Container.
While testing the image, the CLI downloads the image if it is not already available locally in your Docker daemon.
Snyk plans to expand the scope of container scanning, so if there are more files, such as Dockerfiles or workflows that you want to be supported, submit a feature request to Snyk support.
