Riva On-Premise: Enable DEBUG, TRACE, or VERBOSE Logging

Article ID: 67
Last updated: 15 Oct, 2019

Purpose of DEBUG, TRACE, or VERBOSE Logging

When trying to troubleshoot a problem, it can often be helpful to increase the logging level of the affected component. This should be done with great care, because the amount of information logged is substantially larger. Logging should be returned to a normal level after troubleshooting. Do not leave DEBUG, TRACE, or VERBOSE logging enabled, because that will result in Riva creating a lot of large log files and reduce sync performance.

Manual Procedure — in a Config File

How to enable DEBUG, TRACE, or VERBOSE logging

DEBUG, TRACE, or VERBOSE logging is enabled by creating or updating a .config file for the service executable or application that you want to enable that kind of logging for:

  • Riva Manager application: RivaApp.exe.config
  • Riva CRM Agent for Exchange or Domino/Notes: Omni.Riva.CrmAgentEx.exe.config
  • Riva CRM Agent for GroupWise: Omni.Riva.CrmAgent.exe.config
  • Riva Identity Integration Agent (GroupWise for AD): Omni.Riva.IIAgent.exe.config

To modify the logging level, add the following app.setting to the applicable .config file in the Riva\Application\Base or Riva\Application\<version number> folder (see How to create an App.Setting file to enable advanced options):

<add key="LoggingLevel" value="LEVEL" /> where "LEVEL" indicates the logging level, for example "DEBUG":

<add key="LoggingLevel" value="DEBUG" /> (To enable DEBUG logging mode.)
<add key="LoggingLevel" value="TRACE" /> (To enable TRACE logging mode.)
<add key="LoggingLevel" value="VERBOSE" /> (To enable VERBOSE logging mode.)

Example that can be copied and pasted into a blank file:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <appSettings>
    <add key="LoggingLevel" value="DEBUG" />
  </appSettings>
</configuration>

Based on the above component that you want to modify, create a text file in which the advanced configurations are entered. This file needs to be saved to the latest Riva application folder:

  • Riva\Application\Base for a new installation
  • Riva\Application\<latest version> for an updated installation.
     
For an overview of the logging levels, see Logging levels in the article How to manage Riva On-Premise logging.

IMPORTANT! Save the file, and restart the component. To restart the component, do any of the following:

  • In the Riva Service Monitor, select Restart; or
  • Exit the Riva Manager application, and restart it.

How to disable DEBUG, TRACE, or VERBOSE logging

To return logging levels to a normal level:

  1. Do one of the following:

    • In the .config file where the DEBUG, TRACE, or VERBOSE logging was enabled, remove any line that is identical to one of these:

      • <add key="LoggingLevel" value="DEBUG" />,

      • <add key="LoggingLevel" value="TRACE" />, or

      • <add key="LoggingLevel" value="VERBOSE" />

      - OR -
    • Modify the .config file to change the key value from DEBUG, TRACE, or VERBOSE to INFO
      - OR -

    • Rename the .config file by adding a .bak extension to the file name. DO NOT do this if there are other keys in the file, unless you need to disable them too.

  2. If that was the only "add key=" line in the file, remove the .config file from its folder. Otherwise, save the file, and retain it in its folder.

  3. Start the Riva sync service in the Riva Service Monitor application or in the Windows services applet (services.msc) or restart the Riva Manager application.

Riva upgrades preserve .CONFIG files

The Riva upgrade process copies the .CONFIG files to the latest version folder.

Procedure in the Riva Manager Application

Riva 2.4.42 or higher.

Note: The following procedure applies only to the 32-bit Riva sync service, the standard installed service. It does not apply the option for the Riva Manager application or for the 64-bit service, which requires the manual procedure - Config File.

To enable the logging level in the Riva Manager application:

  1. In the Riva Manager application, on the menu bar, select Tools, and then choose Set Logging Level.

  2. In the Set Logging Level window that appears, select a level, and then select Save.

  3. Restart the Riva Service Monitor to put the change into effect.



Article ID: 67
Last updated: 15 Oct, 2019
Revision: 7
Views: 8971
Also read
item Upgrade Riva On-Premise to the Latest Public Release
item Create an App.Setting File to Enable Advanced Options
item How to Troubleshoot a Server Abend
item Riva Sync Service Does Not Start: WARNING! Less Than 100 MB of Free Disk Space Detected
item How to Manage Riva Server Logging

Also listed in
folder Legacy Product Archive -> Riva Identity Integration Server -> Riva Identity Integration - FAQs, Tips & Tricks
folder Riva On-Premise - CRM Sync -> Manage Riva On-Premise (Admin Guides) -> Troubleshooting (Includes Monitoring)

Prev     Next
Configure Web \ HTTP Proxy Authentication Support       Create an App.Setting File to Enable Advanced Options


Back to Top