How do I change logging levels?

As a Cibecs admin you may be requested to change the logging level for different Cibecs components for troubleshooting requirements.

What logging levels are available?

The default logging level is INFO, which will log out the basic information recorded for the components including warnings and errors.

In scenarios where there is a particular bug or unexpected behavior of the component, it may be necessary to switch to a logging level that will log out additional information with more granularity.

Examples of these levels are:

DEBUG - Includes granular logging information that may be used to perform diagnostics on the application.

TRACE - Includes fine granular logging information for in-depth analysis. This logging level may be very resource intensive, so it is very important that it is not left on this level for prolonged periods.

Changing the logging levels

There are 3 different on-premises components that may need to be configured.

1. AD Connector
2. Private Cloud Vault
3. Protection Agent 

AD Connector

In order to change the logging level for the AD Connector you need to follow these steps on the server where the AD Connector is installed:

1. Stop the AD Connector service
2. Browse the the path "INSTALL DIR:\Program Files\Cibecs\ADConnector\config\"
3. Edit the "application.properties" file in a text editor of your choice
4. Update the value "logging.level.mu.cibecs=INFO" from INFO to the requested value for example TRACE or DEBUG
5. Save the changes to the file
6. Start the AD Connector service

If it was successfully applied then you will see TRACE or DEBUG entries in the AD Connector log file.  Look in "INSTALL DIR:\Program Files\Cibecs\ADConnector\logs\adconnector.log" for the log. 

Private Cloud Vault

In order to change the logging level for the Private Cloud Vault you need to follow these steps on the server where the Vault is installed:

1. Stop the Vault service
2. Browse the the path "INSTALL DIR:\Program Files\Cibecs\Vault\config\"
3. Edit the "application-prod.properties" file in a text editor of your choice
4. Update the value "logging.level.mu.cibecs=INFO" from INFO to the requested value for example TRACE or DEBUG
5. Save the changes to the file
6. Start the Vault service

If it was successfully applied then you will see TRACE or DEBUG entries in the Vault log file.  Look in "INSTALL DIR:\Program Files\Cibecs\Vault\logs\vault.log" for the log. 

Protection Agent

In order to change the logging level for the Protection Agent you need to follow these steps on the device where the agent is installed:

1. Stop the Protection Agent by exiting it from the system tray icon
2. Browse the the path "INSTALL DIR:Program Files (x86)\Cibecs\Agent\config\"
3. Edit the "logback-agent.xml" file in a text editor of your choice
4. Update the value " <logger name="mu.cibecs.agent" level="INFO" /> from INFO to the requested value for example TRACE or DEBUG
5. Save the changes to the file
6. Start the Protection Agent application

If it was successfully applied then you will see TRACE or DEBUG entries in the agent log file.  Look in "%appdata%\Cibecs\Agent\Logs\agent.log" for the log