How to Manage Riva Server Logging

Purpose

This guide explains how Riva logging works, what types of logs are generated, and how administrators can configure, locate, and manage those logs for troubleshooting and operational visibility.

Types of Riva Logs

System Logs

These are technical logs used to troubleshoot server-level operations and services. They are stored in the default Riva Logs folder.

Per-User CRM Activity Logs

These are plain-language logs showing historical sync activities for individual users. They are visible in the Riva Service Monitor and stored in folders named for the sync policy and user. In recent versions, the path starts with the sync policy name.

System Logs: Structure and Management

File Naming and Rollover

System logs use a naming pattern that helps you understand:

• The type of log

• When the service started

• Daily rollover markers

• File sequence numbers for restarts and size limits

For example: crmex-log(2018-6-5)-1.2018-06-13.6.txt.

This includes:

• Prefix (crmex-log)

• Execution start date (2018-6-5)

• Execution restart counter (-1)

• Daily rollover date (2018-06-13)

• File size rollover identifier (6)

Riva automatically:

• Rollover logs at midnight (local time)

• Rollover when they reach ~10 MB in size. 

System Logs Prefix

Riva generates different logs prefixes for each type of system log: 

• log files (report on the Riva Manager application): Use these when experiencing connection or impersonation test failures.
• crmex-log files (reports on the CRM Agent service for Exchange): Use these when diagnosing errors reported in the Riva Service Monitor.
• crmmon-log files (reports on the Riva Service Monitor application): Use these when seeing the Riva Service Monitor application experience an issue.

Logging Level

Riva uses the log4net framework. You can adjust how much detail is written to logs by setting the logging level.

Note: High-verbosity levels (DEBUG, TRACE, VERBOSE) create large logs and should only be enabled when requested by support.

Adjust System Log Settings

Change Logging Level

To change the system log level:

1. Edit or create an appSetting in the relevant .config file.

2. Set the level like:

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

To restore default behavior, either:

• Remove the setting, or

• Change it back to "INFO"

Adjust File Sizes and Retention

Retention of zipped logs:

• Riva keeps zipped system logs by defined time (weeks) and total size (MB).

• Defaults can be changed using:

<add key="Crm.LogManager.ArchivedLogsRetentionWeeks" value="n" />
<add key="Crm.LogManager.ArchivedLogsSizeMB" value="n" />

Where n is your desired retention period (weeks) or size (MB).

Add these keys to the applicable CRM Agent service configuration file — typically Omni.Riva.CrmAgentEx.exe.config or Omni.Riva.CrmAgentEx64.exe.config — located in the Riva/Application/{Version Number} folder.

Move Log File Location

By default, logs are stored under the Riva application directory. To move them to another location (for example, a different drive):

<add key="DefaultLogsDirectory" value="D:\Riva\Logs\" />

You can also move logs for specific components by updating the respective .config files for each service.

Add this key to the relevant .config file(s) in Riva\Application\<version>\:

Log Prefixes

Log prefixes help identify the source of events:

Per-User CRM Activity Logs 

These logs show user-specific sync activity, similar to what’s shown in Monitor Activity in the Riva Service Monitor. They are useful for diagnosing user-level issues.

Adjust Retention Period 

To change how long user activity logs are kept before deletion (default ~14 days):

<add key="Crm.EventLogs.RetentionDays" value="n" />

Where n is the number of days. Add the key to Omni.Riva.CrmMonitor.exe.config.