Setting the Logging Level

You can set Advance's logging level to capture more detailed logging information for troubleshooting purposes.

Logging Levels

Advance uses the Serilog logging framework. Advance supports the following Serilog logging levels, in order of least to most detailed:

  • Info
  • Debug
  • Trace

By default, Advance is configured to use the Info logging level.

To set the logging level manually

Among others, Advance comprises the following applications: HdaApi, HdaRoot, HdaAuth, and HdaUi. You can manually change the logging level used by an individual application by editing the *Settings.json file for the application.

For example, to edit the logging level of the HdaApi application:

  1. Navigate to the Advance installation directory; by default, this is C:\inetpub\wwwroot\.
  2. Open the HdaApi application folder.
  3. Edit the HdaApiSettings.json file.
  4. Change the value of the LogLevel setting to the value required, e.g. Info, Debug, or Trace.
  5. Save your changes.

The application will now log messages at the specified level. You may need to restart Advance in IIS before you see the new logging messages in the Advance log.

To set the logging level using the Advance installer

Pre-installation

You can set the logging level before you install Advance by editing the HdaInstallerSettings file.

  1. Edit the HdaInstallerSettings.json file used by the installer.
  2. Uncomment the LogLevel setting under the SiteSettings section.
  3. Change the LogLevel value to one of the logging levels listed above.
  4. Run the installer following the steps in the Installing HotDocs Advance topic.

Post-installation

If you have already installed Advance, you can update the logging level by editing the Advance site settings.

  1. Edit the HdaInstallerSettings.json file you used during installation; make sure this contains the settings with which you originally installed Advance.
  2. Uncomment the LogLevel setting under the SiteSettings section.
  3. Change the LogLevel value to one of the logging levels listed above.
  4. Follow the steps in the Generating Site Settings Files topic to generate the new site settings files 
  5. Follow the steps in the to Uploading Site Settings Files upload the Advance site settings files to your Advance installation.

Once the settings are uploaded, logging messages for the specified logging level will appear in the Advance logs.