Report Server and User management server Log Files

7 mins read

Report Server and User Management Server Log files

In computing, a log file records events that occurs in an operating system or other software. It contains information used when reviewing the problem request.

Error logs

In Syncfusion Report Server or Syncfusion User Management Server, error log files are generated when an exception occurs while configuring or interacting with a report server or user management server. They are generated in the name “errors.txt”.

Debug logs

Event log files holds the complete user interaction details one after the other, when interacting with a report hosted in the Report Server. They are generated in the name “debug-info.txt”.

Location of log files

For any configurations made in the Report Server, log files are generated in different folders listed in the following table based on the nature of the error:

Application	Folder name	Description
Report Server	API	Error logs are generated while accessing the Report Server related API with unexpected or irrelevant parameters. For example, when someone tries to get user details using an invalid user ID, an error log is generated.
	ReportServer.Web	Error logs are generated when unexpected behavior happens in the Report Server. For example, when someone tries to render a deleted report mistakenly, an error log is generated.
	ScheduleService	Error logs are generated when exporting the reports or email notification option fails in a report.
	Report Service	Error logs are generated when there is an issue in processing the reports, datasource, or datasets.
User Management Server	API	Error logs are generated when there is an issue in accessing the registered applications or accessing the API’s.
	UMS.web	Error logs are generated when there is an issue in login or any unexpected behavior in User management server.
	Windows Authentication	Error logs are generated when login user details do not match the imported user details.
	ScheduleService	Error logs are generated when the synchronization fails with saved Active directory or Azure users.

You can collect the log files from the following location to share with us.

Application

Location

Report Server

[installed drive]: \Syncfusion\Report Server\ReportServer.Web\App_Data\Logs

C:\Syncfusion\Report Server\ReportServer.Web\App_Data\Logs

User Management Server

[installed drive]: \Syncfusion\UMS\UMS.Web\App_Data\Logs

C:\Syncfusion\UMS\UMS.Web\App_Data\Logs

Azure App Service

Users who deployed the Report Server and User Management Server in Azure App Service should follow the given steps to take log files:

Log in to the Azure portal: https://portal.azure.com.
Select the Syncfusion Report Server App Service.
Stop the Report Server Azure App Service and then, click Get publish profile.

App service details

Save the <App service name>.PublishSettings file and open it. The file contains 2 <publishProfile> sections for Web Deploy and FTP.
From the FTP <publishProfile> section, copy the following values:

publishUrl

username

userPWD

Publish Profile in FTP Publish settings file

Using these credentials in the FTP client FileZilla, plug these values into the Host, Username, and Password fields as shown here, and click Quickconnect.

FTP client to connect with the Report Server app service

Share the logs from following location “/site/wwwroot/App_Data/Logs” as shown below.

logs location in Azure app service for file storage

Note:

Follow the above similar steps to collect the logs for the User Management Server App Service.

For Verbose logging

Verbose logging is a computer logging mode that records more information than the usual logging. (Verbose means using more words than necessary). In some scenarios, normal logging does not provide more information required for troubleshooting the issue. In such case, verbose logging is used.

To enable the verbose logging system, set the key ‘IsLogOptionalData’ to true in the Report Server, API, Windows Authentication, and Scheduler Service web config files. Additional log information including parameters or other key values that causes exception is added to log files.

Log optional data

Location of config files

Application	Project	Location
Report Server	Report Server	[installed drive]: \Syncfusion\Report Server\ReportServer.Web\Web.config
	API	[installed drive]: \Syncfusion\Report Server\ReportServer.Web\API\Web.config
	Scheduler Service	[installed drive]: \Syncfusion\Report Server\SchedulerServiceInstaller\Syncfusion.Server.Base.Reports.SchedulerService.exe.config
User Management Server	User management server	[installed drive]: \Syncfusion\UMS\UMS.Web\Web.config
	API	[installed drive]: \Syncfusion\UMS\UMS.Web\API\Web.config
	Windows Authentication	[installed drive]: \Syncfusion\UMS\UMS.Web\WindowsAuthentication\Web.config
	Scheduler service	[installed drive]: \Syncfusion\UMS\SchedulerServiceInstaller\Syncfusion.Server.Base.UMS.SchedulerService.exe.config

After completing the above changes, replicate the issue and collect the log files from the below location to share with us.