How To
ForgeRock Identity Platform
Does not apply to Identity Cloud

How do I enable debug logging for connectors in IDM (All versions)?

Last updated Nov 22, 2021

The purpose of this article is to provide information on enabling debug logging for connectors in IDM to assist in troubleshooting. It also provides details on restricting logging to a particular connector.


Enabling debug logging for connectors

You can enable debug logging for the OpenICF framework, all connectors or a specific connector as follows:

  1. Shutdown the IDM instance:$ cd /path/to/idm $ ./shutdown.sh
  2. Increase the logging level for the OpenICF framework and/or connectors by adding the following properties to the logging.properties file (located in the /path/to/idm/conf directory) depending on what you want to debug:
    • Debug the OpenICF framework (you can use this in conjunction with all connector debugging or specific connector debugging):org.forgerock.openidm.provisioner.openicf.level = FINEST
    • Debug all connectors:org.forgerock.openicf.connectors.level = FINEST org.identityconnectors.level = FINEST
    • Debug a specific connector - see the table below for which properties should be added for each connector.
  3. Restart the IDM instance:$ cd /path/to/idm $ ./startup.sh

Once you have reproduced the problem and collected the logs, you should remove or comment out the properties you added in step 2 to avoid filling up the disks where the logs are stored.

Debug properties for connectors

The following table shows which properties should be added to the logging.properties file to enable debug logging for a specific connector:

Connector Required Properties
Adobe Marketing Cloud Connector org.forgerock.openicf.acm.level = FINEST
CSV File Connector org.forgerock.openicf.csvfile.level = FINEST
Database Table Connector org.identityconnectors.databasetable.level = FINEST
DocuSign Connector org.forgerock.openicf.connectors.docusign.level = FINEST
Google Apps Connector org.forgerock.openicf.connectors.googleapps.level = FINEST
Groovy Connector Toolkit org.forgerock.openicf.connectors.groovy.level = FINEST
HubSpot Connector rg.forgerock.openicf.connectors.hubspot.level = FINEST
Kerberos Connector org.forgerock.openicf.connectors.kerberos.level = FINEST
LDAP Connector org.identityconnectors.ldap.level = FINEST
Marketo Connector org.forgerock.openicf.connectors.marketo.level = FINEST
MongoDB Connector org.forgerock.openicf.connectors.mongodb.level = FINEST
MS Graph API Java Connector org.forgerock.openicf.connectors.msgraphapi.level = FINEST
PowerShell Connector Toolkit Org.ForgeRock.OpenICF.Connectors.MsPowerShell.level = FINEST
Salesforce Connector org.forgerock.openicf.connectors.salesforce.level = FINEST
SAP Connector org.forgerock.openicf.connectors.sap.level=FINEST scripts.sap.r3.level=FINEST scripts.sap.hr.level=FINEST scripts.sap.level=FINEST
SCIM Connector org.forgerock.openicf.connectors.scim.level = FINEST
Scripted REST Connector org.forgerock.openicf.connectors.scriptedrest.level = FINEST
Scripted SQL Connector org.forgerock.openicf.connectors.scriptedsql.level = FINEST
ServiceNow Connector org.forgerock.openicf.connectors.servicenow.level = FINEST
SSH Connector org.forgerock.openicf.connectors.ssh.level = FINEST
Workday Connector org.forgerock.openicf.connectors.workday.level = FINEST

See Also

Troubleshooting IDM

Troubleshooting Connectors

Configure Server Logs

Related Training

N/A

Related Issue Tracker IDs

N/A


Copyright and Trademarks Copyright © 2021 ForgeRock, all rights reserved.