community
cancel
Showing results for 
Search instead for 
Did you mean: 

Alteryx Designer Knowledge Base

Definitive answers from Designer experts.
#SANTALYTICS

The highly anticipated Alteryx Community tradition is back! We hope you'll join us!

Learn More
We will be upgrading the Gallery to our 2019.4 release this Saturday, December 7th beginning at 9:00am MT. We expect the outage to take last approx. 2.5 hours.

How to enable installation logs for Python-based tools

Moderator
Moderator
Created on

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, as pip is used in the background during installation, there are two complementary options are available :

 

  • set the output to verbose
  • 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 named pip (example: C:\ProgramData\pip or C:\users\me\AppData\Roaming\pip)

 

3. In pip folder, create a file called pip.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 the path of the file that will contain all the messages generated by pip

 

An example of the resulting 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
Alteryx
Alteryx

Great post @PaulN, great Tips for troubleshooting!