Exago keeps a text log of when certain tasks are performed. For example each time a page or report is loaded, each time an error occurs or when various phases of execution happen.
NoteThis article references
<WebApp>/,<WebSvc>/,<ScdlSrvc>/and<Temp>/as a placeholder for the install location of the Web Application, Web Service API, Scheduler Service and Exago's Temp Path respectively.
To configure logging, refer to the Application and Performance Logging article.
Web Application Log
To access the log file and troubleshoot an error in the application:
- Ensure that in the Admin Console that General > Other Settings > Write Log File is set higher than None.
Important
Setting the log level to DEBUG in a production environment can have unintended performance consequences. Only use DEBUG level logging in production temporarily and under advisement from the Exago Support, Services or Development teams.
- Recreate the error you are investigating.
- Navigate to the folder specified in General > Main Settings > Temp Path. If this is blank go to
<WebApp>\Temp. If General > Scheduler Settings > Enable Remote Report Execution is set to True the report execution will instead be be recorded in the Scheduler Log. - Open the file WebReportsLog.txt. Scroll to the bottom of the file for the most recent activity.
NoteOccasionally IIS may lock this file and prevent the log from being written. To correct this problem, see Application Logging.
Scheduler Service & Remote Execution Log
Similar to the Web Application, the Scheduler Service maintains a log file. Considering the Scheduler can reside on a different machine than the main application, the log file is written where the Scheduler is installed.
Since Remote Execution is handled by Scheduler Services, if Remote Execution is enabled in the environment, all report execution will be logged into the Scheduler Service's log.
To access the Scheduler Service log file:
- Set
<logging>to on in the Scheduler Service's configuration file. - Rerun the scheduled report under investigation.
- Open the file
<ScdlSrvc>\eWebReportsScheduler.log. Scroll to the bottom of the log for the most recent activity.
Web Service API Log
Similar to the Web Application, the Web Service API maintains a log file. Considering the Web Service API can reside on a different machine than the Web Application, the log file is written where the Web Service is installed.
To access the Web Service API log file:
- Set
<writelog>to True in the Web Service API's configuration file. - Rerun the project that makes the API calls under investigation.
- Open the file
<Temp>\WebReportsApiLog.txt. Scroll to the bottom of the file for the most recent activity.
.NET API Log
Some implementations of the .NET API may write to a log file as well.
For versions prior to v2018.1, the API logs to the same file as the Web Application.
In v2018.1+, the log file for the built-in logging methods defaults to <Temp>\WebReportsApiLog.txt