Community Spring Cleaning week is here! Join your fellow Maveryx in digging through your old posts and marking comments on them as solved. Learn more here!

Alteryx Designer Desktop Knowledge Base

Definitive answers from Designer Desktop experts.

How to enable installation logs for Python-based tools

PaulN
Alteryx Alumni (Retired)
Created

Sometimes, to analyze and troubleshoot installation issues for Python based tools, you may need more information than the messages populated in the tool installer window.

Fortunately, aspip is used in the background duringinstallation, there are two complementary options are available :

  • set the output toverbose
  • save the trace in a file

These parameters can be set up through a configuration file: pip.ini

For reference:https://pip.pypa.io/en/latest/user_guide/#config-file

Procedure:

1. Choose a root folder:

%PROGRAMDATA% for all users on the machine

%APPDATA% for current user

2. Create a folder namedpip (example: C:\ProgramData\pip or C:\users\me\AppData\Roaming\pip)

3. Inpip folder, create a file calledpip.ini

4. Edit pip.ini with the following:

[global] verbose = yes log = C:\ProgramData\Alteryx\Engine\pip_log.txt

Remarks:

[global] is case sensitive

verbose specifies that output should contain more details.

log is thepath of the file that will contain all the messages generated by pip

An example of theresulting file:

Notepad2_2018-10-16_22-22-59.png

5. Install your YXI file as usual

6. [optional but recommended] Rename pip.ini to pip.ini.old when you are done!

To keep in mind:

  • previous steps will enable logs globally - except for Python tool and any Python environments. As a result, messages displayed in Alteryx Designer during the installation process will be more verbose too.
  • logs always add to the file. If multiple installations occur sequentially, they will all be saved in the same file. The log file is not purged or deleted automatically.
  • Verbose and logs may significantly extend installation time.
  • pip logs should be stored on a local drive.

Best practice:

Only enable logs for support/debugging purpose!

Comments
ChristianR
Alteryx
Alteryx

Great post @PaulN, great Tips for troubleshooting!