Generating and Locating NI Package Manager Error Logs

Issue Details

• I would like to troubleshoot an issue with NI Package Manager (NIPM), however I don't know what logs are relevant, how to generate them, or where they are located on disk.
• I have a problem with NI Package Manager (NIPM) and need to obtain a cURL or Networking Log for troubleshooting. How do I create that log file?

Solution

Default Error Logs

There are error logs that are enabled and generated by default when an issue occurs with NI Package Manager. They are located locally at C:\Users\<Windows Username>\AppData\Local\National Instruments\NI Package Manager\Logs

Note: By default, the AppData directory is hidden on Windows machines. If you cannot find the AppData folder on your system, navigate to C:\Users\<Windows Username>\ and follow Microsoft's directions on this page to show hidden folders.

Configuring Additional Error Logs

Two additional logs, cURL log and the MSI log, can also help with troubleshooting issues. To enable or disable these additional logs, use the following commands on your local command prompt terminal:

• Enabling MSI Logs:
  "C:\Program Files\National Instruments\NI Package Manager\nipkg.exe" config-set nipkg.plugin.wininst.msilogs-enabled=true
• Disabling MSI Logs:
  "C:\Program Files\National Instruments\NI Package Manager\nipkg.exe" config-set nipkg.plugin.wininst.msilogs-enabled=false
• Enabling cURL Logs:
  "C:\Program Files\National Instruments\NI Package Manager\nipkg.exe" config-set nipkg.curldebugfile-enable=true
• Disabling cURL Logs:
  "C:\Program Files\National Instruments\NI Package Manager\nipkg.exe" config-set nipkg.curldebugfile-enable=false

After enabling the log generation, reproduce the error in NI Package Manager again as logs will only be created when an error is encountered. These additional error logs will also be placed in ​C:\Users\<Windows Username>\AppData\Local\National Instruments\NI Package Manager\logs

Note: NI recommends disabling MSI logs after finishing troubleshooting installation issues. Having MSI logs enabled will increase the time it takes to install packages significantly.

Additional Information

Reading NI Package Manager error logs

The NI Package Manager error log files can be difficult to interpret as they include a very detailed protocol of the download and installation process of packages. If you have a failed package that you are troubleshooting, look for an associated error message in the logs, and determine whether it is coming from the server, copying files, installation, or the like.

Using a search function to search for the word "error" inside the log files can help to locate errors in the log, and may help identify the location of errors by reading the surrounding text.