User Tools

Site Tools


Replicator Agent Logging

To set the logging level at the command line you can enter in the appropriate command for you agent version. At the command line you can set the logging level for a certain duration or indefinitely. You can also manually set the logging level, see here. Note, setting it manually will set it indefinitely.

It can be helpful to have the logging set to FINEST/DEBUG during installation but it is recommended to have logging set to INFO during production.

Dynamically Setting the Logging Version

By default, the logging level of the Replicator agent is set at INFO. This setting incurs minimal logging and is a good candidate for every day use.

The logging level can be dynamically changed using the setLogging command. This command is useful during troubleshooting to obtain greater detail of the processing taking place. You may be asked to increase the logging level to finest by using the setLogging command.

The setLogging command has the following syntax:


The LOGGING_LEVEL argument is required and must be either “finest” or “info”. As of 3.23.0, users may now select “debug” as an argument.

The DURATION argument is used to specify how many seconds the change in logging level is to remain in affect. The default is one hour and by setting it to -1 it will remain indefinitely. Typically the logging level is changed to finest only during troubleshooting, this approach ensures that info level debugging is resumed after an hour.

For example you can call the following commands from the root Perspectium directory:

# Setting to finest logging for an hour
bin/setLogging finest
# Setting to finest logging for 3 hours (10800 seconds) 
bin/setLogging finest 10800
# Setting to info logging indefinitely
bin/setLogging info -1 

Note: this is will stay in affect until the Agent is restarted or the duration expires.

Manually Setting the Logging Level

You can manually set the logging level by editing a single line of the config. Log into the host that the agent is installed on and navigate to the home directory of the Agent and edit the log4j2.xml file within the conf folder.

You will change the property <Root level=“DEBUG”> to: INFO, DEBUG, or FINEST.

Finest provides the most detail and info provides the least. Save the file and restart the agent to implement the change. This will stay in affect through Agent restarts until it is modified back. You can still modify the logging level through the previous bin/setLogging command above.

Additional Configurations

There are additional changes you can make to alter the logs to your liking or to add when troubleshooting. The file within the conf folder contains information and examples for such changes.

Debugging Database IO MSSQL

For example to enable debugging logs for I/O through the JDBC of MSSQL you can append the following to the end of = DEBUG
replicator_agent_logging.txt · Last modified: 2017/06/09 10:02 by vinhn