CCG Enable Debug Log by Connector

CCG Enable Debug Log by Connector

IMPORTANT:  The method of configuring logging levels per connector that is described in this document has been been updated. Logging functionality is now configurable by API. For more information see the corresponding API Reference documentation.

 

Overview

IdentityNow's VA has the ability for the SailPoint user to directly configure logging levels per connector by setting connector class log levels.

This is very beneficial as the standard debug option (Connections -> Virtual Appliances -> Cluster -> Enable Debugging) is not sustainable due to the amount of information it delivers. The CCG logs on the VA can be found at /home/sailpoint/log.

The Cloud Connector Gateway (CCG) uses either log4j or log4j2 to log information about the connector operations it is performing and each logger has its own logging configuration format. Log4j uses a properties file where log4j2 configuration uses XML. The format of the logging configuration that will need to be updated will depend on the version of the CCG running on your VA. An example of each file type is attached to this document.

 

Set up debug/debug logging

Modifying log4j2.properties

  1. Log into VA and perform the following.
  2. Take ownership of the CCG folder using the sudo chown -R sailpoint /home/sailpoint/ccg command.
  3. Stop CCG with the sudo systemctl stop ccg command.
  4. Open file log4j2.properties at the following location:
    vi /home/sailpoint/ccg/log4j2.properties
  5. Change your logger entry such as following, for your connector. For example:
    logger.connector.name = sailpoint.connector.ADLDAPConnector
    logger.connector.level = info
    logger.connector.additivity = false
    logger.connector.appenderRef.rolling.ref = STDOUT
  6. Save the log4j2.properties file.
  7. Start CCG with the sudo systemctl start ccg command.

 

Revert to default log levels

  1. Log into the VA
  2. Remove the log4j file:
    rm /home/sailpoint/ccg/log4j.properties
    or
    rm /home/sailpoint/ccg/log4j2.properties
  3. Restart the CCG:
    sudo systemctl restart ccg

 

Loggers

The following are the examples of loggers. 

The difference in syntax between log4j and log4j2 is straight forward. The log4j config will have a property value similar to:

log4j.logger.sailpoint.connector.ADLDAPConnector=debug

Log4j2 will have an XML element similar to:

<Logger name="sailpoint.connector.ADLDAPConnector" level="debug" />

 

Connector Logger Path
Active Directory-Direct logger.sailpoint.name = sailpoint.connector.ADLDAPConnector

logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

 

logger.sailpoint.name = sailpoint.connector.LDAPConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

AIX - Direct

logger.openconnector.name = openconnector.connector.unix.UnixConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

logger.openconnector.name = openconnector.connector.unix.AIXConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

 

Azure AD logger.sailpoint.name = sailpoint.connector.AzureADConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
Box logger.openconnector.name = openconnector.connector.BoxNetConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Cerner logger.openconnector.name = openconnector.connector.CernerConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
DelimitedFile logger.sailpoint.name = sailpoint.connector.DelimitedFileConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

 

Drop Box

logger.DropBox.name=openconnector.connector.DropBoxConnector

logger.DropBox.level=debug

logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Epic logger.openconnector.name = openconnector.connector.EPICConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

 

GE Centricity logger.openconnector.name = openconnector.connector.GECentricity
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Gsuite/GoogleApps

logger.openconnector.name = openconnector.connector.GoogleAppsDirect
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.OpenConnectorAdapter
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

 IBM i

logger.openconnector.name = openconnector.connector.IBMiConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

IBM Lotus Domino logger.sailpoint.name = sailpoint.connector.LotusDomino
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
JDBC logger.sailpoint.name = sailpoint.connector.JDBCConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
LDAP/SUNONE logger.sailpoint.name = sailpoint.connector.LDAPConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
Linux - Direct

logger.sailpoint.name = sailpoint.connector.UnixConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT 

logger.openconnector.name = openconnector.connector.unix.LinuxConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Microsoft Office365 logger.sailpoint.name = sailpoint.connector.Office365Connector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
Microsoft SQL Server – Direct 

logger.sailpoint.name = sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2

logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Oracle Database - Direct

logger.sailpoint.name = sailpoint.connector.OracleDBConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.JDBCConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Oracle E-Business

logger.sailpoint.name = sailpoint.connector.OracleEBSConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.JDBCConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Oracle Fusion HCM

logger.oracleHCM.name=openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector
logger.oracleHCM.level=debug

logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Package : openconnector.connector.oraclefusionhcm

Connector class : openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector

 

Oracle HRMS

logger.sailpoint.name = sailpoint.connector.OracleAppsHRMSConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.JDBCConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

PeopleSoft - Direct

logger.openconnector.name = openconnector.connector.PeopleSoftConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

PeopleSoftHRMS - Direct logger.sailpoint.name = sailpoint.connector.PeopleSoftHRMSConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

 

RemedyForce logger.sailpoint.name = sailpoint.connector.ForceConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
RSA Autehentication Manager

logger.openconnector.name = openconnector.connector.RSAConnector

logger.openconnector.name =openconnector.connector.rsa.RSAHTTPClient

logger.openconnector.level = debug

logger.openconnector.additivity = false

logger.openconnector.appenderRef.rolling.ref = STDOUT

Salesforce logger.sailpoint.name = sailpoint.connector.ForceConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
SAP - Direct

logger.sailpoint.name = sailpoint.connector.SAPConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.SAPInternalConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

SAP HR/HCM

logger.sailpoint.name = sailpoint.connector.SAPHRConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

SCIM1 logger.openconnector.name = openconnector.connector.SCIMConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
SCIM2.0

logger.openconnector.name = openconnector.connector.scim2.SCIM2Connector

logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Package: openconnector.connector.scim2

Connector class : openconnector.connector.scim2.SCIM2Connector

ServiceNow logger.openconnector.name = openconnector.connector.servicenow.ServiceNowConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

logger.openconnector.name = openconnector.connector.servicenow.
 ServiceNowRestClient
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
ServiceNow Integration logger.openconnector.name = openconnector.connector.servicedesk.ServiceNowServiceDeskConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Siebel

logger.openconnector.name = openconnector.connector.SiebelConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Solaris - Direct

logger.openconnector.name = openconnector.connector.unix.UnixConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

logger.openconnector.name = openconnector.connector.unix.SolarisConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

SuccessFactors - Direct

logger.sailpoint.name = sailpoint.connector.SuccessFactorsConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Sybase - Direct

logger.sailpoint.name = sailpoint.connector.SybaseDirectConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

logger.sailpoint.name = sailpoint.connector.JDBCConnector
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT

Webex

logger.openconnector.name = openconnector.connector.Webex
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Workday

logger.openconnector.name = openconnector.connector.WorkDay
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Package : openconnector.connector.workday

Connector class : openconnector.connector.WorkDay

Workday Accounts

logger.openconnector.name = openconnector.connector.workdayaccounts
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

Package: openconnector.connector.workdayaccounts

Connector class : openconnector.connector.workdayaccounts.WorkdayAccountsConnector

Web Services logger.sailpoint.name = sailpoint.connector.webservices
logger.sailpoint.level = debug
logger.sailpoint.additivity = false
logger.sailpoint.appenderRef.rolling.ref = STDOUT
XML logger.openconnector.name = openconnector.connector.XMLConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Yammer logger.openconnector.name = openconnector.connector.YammerConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Zoom

logger.openconnector.name = openconnector.connector.zoom
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT

 

Package : openconnector.connector.zoom

Connector class : openconnector.connector.zoom.ZoomConnector

 

 

Utility Classes

 

Purpose Logging Class
HTTP posts back to cloud stack log4j.logger.sailpoint.gateway.accessiq.AggregateHandler = debug
HTTP request/response for connectors log4j.logger.httpclient.wire=debug

log4j.logger.connector.common.http=debug

 

 

Comments

Hi,

     What is the Logger Path for SharePoint Online?

 

Thanks,

Gustavo 

Can you please update this page with new syntax for log4j2.properties? 

 

example, for ad it is: 

logger.ad_connector.name = sailpoint.connector.ADLDAPConnector
logger.ad_connector.level = debug

 

 

Also remember to enable debugging on the VA cluster via 'Connections --> Virtual Appliances --> Enable Debugging'

logger.sdk.name =connector.sdk.webservices

logger.sdk.level = debug
logger.sdk.additivity = false
logger.sdk.appenderRef.rolling.ref = STDOUT

 

logger.http.name = connector.common.http

logger.http.level = debug

logger.http.additivity = false

logger.http.appenderRef.rolling.ref = STDOUT

 

For webservices, apart from the one mentioned we can use above classes for more information.

 

My VA uses log4j2.properties. This guide needs to be updated.

What are the logger paths for VA executed Rules such as BeforeProvisioningRule or WebServiceBeforeOperation Rule?

What is the command to Save the log4j2.properties file.

 

Here is a link to the Doc for using the APIs to enable Connecor logging

Enabling Connector Logging in IdentityNow

Could somebody let me know the connector class name for Atlassian Suite Server?

Hello,

Is there a connector class name for SQL Loader connection ?

Thanks.

Logger for NetSuite:

logger.sp_connector.name =openconnector.connector.netsuite.NetsuiteConnector
logger.sp_connector.level = trace
 

Version history
Revision #:
19 of 19
Last update:
‎Apr 18, 2022 05:15 AM
Updated by: