Configure and Use Logs
Analytics Hub creates log files and saves them to your server's file system. Logs capture warnings and errors and can be used to investigate and diagnose issues. Logging Settings allow you to choose the threshold for the types of messages you want to capture. The default logging level is Debug. A level of Info may be sufficient if you need little logging, while a level of Debug logs more messages to help you troubleshoot. To set the logging level, go to Platform Admin > Settings > Logging > Level. Set a level in the Level drop-down menu, and select Save.
Order of levels from least to most logs created:
- Error—Only logs errors and critical events
- Warning—Logs deprecation messages and more
- Info—Logs information that’s helpful to diagnose a running system (for example, platform started at 5:00pm, 5/20/20; running in prod mode)
- Debug—This is default level and very verbose. It’s useful to developers for debugging problems.
- Trace—Logs every action the system is taking.
File size determines the maximum size of a log file before the logs rotate. This helps prevent the creation of large log files that can be difficult to consume in standard log readers.
Types of Log Files, Locations, and Descriptions
File Name: AlteryxEngineWorker-*.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\Logs\Worker
Engine worker logs document the activity of configured engine workers in the Hub. The worker’s ID is included in the log.
File Name: frontend.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\Logs\Frontend
Frontend logs document the actions taken by users on the Analytics Hub interface.
File Name: analytics-hub-server*.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\Logs\Backend
This log contains system settings and configuration information. To see, download, and refresh your log file, go to Platform Admin > Settings > Logging > View Most Recent Log File. To see older logs, go to your computer’s file browser and the file path you set or the default. Open the log in a text editor or spreadsheet.
File Name: postgresql-*.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\Postgres\data\log
Postgres logs document the status of the PostgreSQL database underlying Analytics Hub.
File Name: installation_summary.log
Default Location: C:\Program Files\Alteryx Analytics Hub\Postgres
The installation summary log contains a summary of the PostgreSQL database installation, including the named admin, port, and installation timestamp.
File Name: AyxAU_*.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\logs\als
The License Server log documents the FlexNet Operations license server calls for retrieving the current seats on Analytics Hub.
File Name: analytics-hub-audit.log
Default Location: INSTALL_LOCATION\Alteryx Analytics Hub\Logs\Audit
Many organizations require an auditable log of all actions in a system for regulatory and security reasons. Analytics Hub audited events include:
- User: Add, Delete, Login
- Files: Create Asset, Modify Asset, Delete Asset
- Job: Start, Complete
- Role: Grant, Remove
- Schedule: Create, Complete
Usernames are intentionally left out of the log. Instead, actions are logged with the unique user ID that performed the action. A lookup table of the user ID and usernames is maintained in the PostgreSQL database.
File Name: Alteryx_Analytics_Hub_*.log
Default Location: C:\Users\USERNAME\AppData\Local\Temp\
Installation logs document the installation process for Analytics Hub, drivers, and the Postgres database.