Register Sign in Need help? FAQ SailPoint directory
Help
cancel
Turn on suggestions
Showing results for 
Show  only  | Search instead for 
Did you mean: 

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, refer to the Enabling Connector Logging in IdentityNow Compass page.

 

 

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.ADLDAPConnector.name = sailpoint.connector.ADLDAPConnector

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

 

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

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

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

 
Amazon Web Services

logger.aws.name=openconnector.connector.aws
logger.aws.level=trace

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

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

 
Drop Box

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

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

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

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

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

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

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

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

logger.SQLServerConnectorV2.name = sailpoint.connector.mssql.serviceimpl.MSSQLServerConnectorV2
logger.SQLServerConnectorV2.level = debug
logger.SQLServerConnectorV2.additivity = false
logger.SQLServerConnectorV2.appenderRef.rolling.ref = STDOUT
Okta

logger.openconnector.name = openconnector.connector.okta.OktaConnector
logger.openconnector.level = debug
logger.openconnector.additivity = false
logger.openconnector.appenderRef.rolling.ref = STDOUT
Oracle Database - Direct

logger.OracleDBConnector.name = sailpoint.connector.OracleDBConnector
logger.OracleDBConnector.level = debug
logger.OracleDBConnector.additivity = false
logger.OracleDBConnector.appenderRef.rolling.ref = STDOUT
Oracle E-Business

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

logger.oracleHCM.name=openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector
logger.oracleHCM.level = debug
logger.oracleHCM.additivity = false
logger.oracleHCM.appenderRef.rolling.ref = STDOUT

Package : openconnector.connector.oraclefusionhcm

Connector class : openconnector.connector.oraclefusionhcm.OracleFusionHCMConnector

 
Oracle HRMS

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

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

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

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

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

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

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

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

logger.SAPGRCConnector.name = sailpoint.connector.sapgrc
logger.SAPGRCConnector.level = debug

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

 
SAP HR/HCM

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

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

Package: openconnector.connector.scim2

Connector class : openconnector.connector.scim2.SCIM2Connector
ServiceNow logger.servicenow.name = openconnector.connector.servicenow.ServiceNowConnector
logger.servicenow.level = debug
logger.servicenow.additivity = false
logger.servicenow.appenderRef.rolling.ref = STDOUT

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

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

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

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

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

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

 
Webex

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

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

Package : openconnector.connector.workday

Connector class : openconnector.connector.WorkDay
Workday Accounts

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

Package: openconnector.connector.workdayaccounts

Connector class : openconnector.connector.workdayaccounts.WorkdayAccountsConnector
Web Services logger.webservices.name = sailpoint.connector.webservices
logger.webservices.level = debug
logger.webservices.additivity = false
logger.webservices.appenderRef.rolling.ref = STDOUT
XML logger.XMLConnector.name = openconnector.connector.XMLConnector
logger.XMLConnectorlevel = debug
logger.XMLConnector.additivity = false
logger.XMLConnector.appenderRef.rolling.ref = STDOUT
Yammer logger.YammerConnector.name = openconnector.connector.YammerConnector
logger.YammerConnector.level = debug
logger.YammerConnector.additivity = false
logger.YammerConnector.appenderRef.rolling.ref = STDOUT
Zoom

logger.zoomname = openconnector.connector.zoom
logger.zoom.level = debug
logger.zoom.additivity = false
logger.zoom.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
gsanr
‎Dec 11, 2019 05:15 PM
‎Dec 11, 2019 05:15 PM

Hi,

     What is the Logger Path for SharePoint Online?

 

Thanks,

Gustavo 

marline
‎Jun 16, 2020 11:31 PM
‎Jun 16, 2020 11:31 PM

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

 

 

blake_bowen
‎Sep 09, 2020 05:34 PM
‎Sep 09, 2020 05:34 PM

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

chirag_patel
‎Oct 09, 2020 07:10 AM
‎Oct 09, 2020 07:10 AM

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.

 

ChrisOlsen
‎Oct 14, 2020 12:45 PM
‎Oct 14, 2020 12:45 PM

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

edgar_lazaro
‎Aug 20, 2021 12:50 PM
‎Aug 20, 2021 12:50 PM

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

Bill_Neaveill
‎Oct 12, 2021 09:16 AM
‎Oct 12, 2021 09:16 AM

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

 

darrell_oregan
‎Jan 10, 2022 10:57 PM
‎Jan 10, 2022 10:57 PM

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

Enabling Connector Logging in IdentityNow

sudhanvan
‎Mar 03, 2022 10:53 AM
‎Mar 03, 2022 10:53 AM

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

adriencosson_aviva
‎May 02, 2022 05:48 AM
‎May 02, 2022 05:48 AM

Hello,

Is there a connector class name for SQL Loader connection ?

Thanks.

riya_phophalia
‎Jun 24, 2022 02:18 PM
‎Jun 24, 2022 02:18 PM

Logger for NetSuite:

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

KarinaB
‎May 08, 2023 08:29 PM
‎May 08, 2023 08:29 PM

Hello folks! 

 Is possible to generate an independent file -logging levels- per connector (application) integrated in SailPoint IIQ 8.3.1? 

ukputta
‎Jul 27, 2023 02:51 AM
‎Jul 27, 2023 02:51 AM

Hi All,

What should be the logger for SAP Concur connector?

sanket
‎Dec 01, 2023 11:12 AM
‎Dec 01, 2023 11:12 AM

Share Point Loggers
logger.connector_O365SharepointOnlineConnector.name=sailpoint.connector.O365SharepointOnlineConnector
logger.connector_O365SharepointOnlineConnector.level=debug
logger.sharepointonline_SPOConnectionManager.name=sailpoint.connector.sharepointonline
logger.sharepointonline_SPOConnectionManager.level=debug

akash_kurane
‎Jan 19, 2024 06:08 AM
‎Jan 19, 2024 06:08 AM

@ukputta  loggers for SAP Concor - 
openconnector.connector.sapconcur.SAPConcurConnector

StephenHolinaty
‎Feb 21, 2024 10:17 AM
‎Feb 21, 2024 10:17 AM

For Oracle HCM Cloud, use
```
logger.connector_OracleHCMCloud.name=openconnector.connector.oraclehcmcloud
logger.connector_OracleHCMCloud.level=debug
logger.connector_OracleHCMCloud.additivity = false
logger.connector_OracleHCMCloud.appenderRef.rolling.ref = STDOUT
```

sergiyshpak
‎Apr 17, 2024 03:44 PM
‎Apr 17, 2024 03:44 PM

ok, article is kind of nice, but config files are owned by root, you cant change them, right?

 

 

StephenHolinaty
‎Apr 23, 2024 03:56 PM
‎Apr 23, 2024 03:56 PM

@sergiyshpak sudo chown -r sailpoint /home/sailpoint/ccg

sergiyshpak
‎Apr 30, 2024 03:03 PM
‎Apr 30, 2024 03:03 PM

does anyone have sudo rights?

what happens if directory changes owner? original process wont be able access that place, right? 

 

StephenHolinaty
‎Apr 30, 2024 03:15 PM
‎Apr 30, 2024 03:15 PM

@sergiyshpak  you can check `sudo -l` for a listing of what commands the sailpoint user has sudoers access to call.
it is rather restricted in terms of what you have the ability to sudo.

RohanBhat10
‎May 27, 2024 01:57 AM
‎May 27, 2024 01:57 AM

What is the logging class to be used for SAP Fieldglass connector.

pdineshs
‎Oct 14, 2024 06:43 AM
‎Oct 14, 2024 06:43 AM

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

I have added below logger, but WebServiceBeforeOperation logs are not printing.

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

bitoshok_das
‎Nov 26, 2024 12:53 AM
‎Nov 26, 2024 12:53 AM

For SQL Loader, use the same class as JDBC connector. 

wendycape
‎Jan 08, 2025 01:38 PM
‎Jan 08, 2025 01:38 PM

Hello,

 

can you help me with Helix, I use BMC Remedy - Direct, please.

Version history
Revision #:
25 of 26
Last update:
‎Apr 11, 2023 11:32 AM
Updated by:
SailPoint Employee
 
View Article History
li.common.scroll-to.top