Enable Connector Logging

This topic provides the steps needed to enable logging on SailPoint using REST APIs.

This process is broken up into four steps:

1. Identify the Virtual Appliance (VA) cluster on which you want to enable logging.
2. Get the logging configuration for the existing VA cluster.
3. Update the VA cluster to enable logging levels.
4. Observe logging changes to the logging levels.

Identify the Virtual Appliance Cluster

Select the VA on which you need to enable logging using REST API. If you already know the VA application's id, proceed to Get the Logging Configuration.

1. Make the following call to the REST API to return a list of available VA clusters:

   GET /v3/managed-clusters

   The REST API returns a response that looks similar to the following:

   [
       {
           "id": "2c9180866166b5b0016167c32ef31a66",
           "name": "Development Cluster",
           "description": "Development Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": null
       },
       {
           "id": "2c9180846a93ce60016ab29f039944de",
           "name": "Cloud Cluster",
           "description": "Cloud Cluster",
           "clientType": "CCG",
           "ccgVersion": "373_535_70.2.0",
           "pinnedConfig": true,
           "logConfiguration": {
               "clientId": null,
               "durationMinutes": 60,
               "expiration": "2020-12-15T19:13:36.079Z",
               "rootLevel": "DEBUG",
               "logLevels": {
                   "sailpoint.connector.ADLDAPConnector": "DEBUG"
               }
           }
       }
   ]
   

   Note

   The previous example code shows two VA clusters. One VA cluster has a log configuration and the other does not (refer to the logConfiguration value in each returned VA cluster). This is because one of the clusters already has logging enabled. This is just an example configuration, and your environment may not have logging enabled on a cluster.

2. Identify the VA cluster that you want to enable logging on by its name or description and record its id attribute.

Get the Logging Configuration

Get your selected VA's cluster logging configuration and identify the values you need to update.

1. Make the following call to the REST API to return the VA cluster's logging configuration. Replace {id} with the VA cluster's id attribute value recorded earlier.

   GET /v3/managed-clusters/{id}/log-config

   • If the VA doesn't have a logging configuration currently set, it returns 204 No Content as a response.

   • If the VA has an existing logging configuration, it returns something similar to the following:

     {
         "clientId": null,
         "durationMinutes": 60,
         "expiration": "2020-12-15T19:13:36.079Z",
         "rootLevel": "DEBUG",
         "logLevels": {
             "sailpoint.connector.ADLDAPConnector": "DEBUG"
         }
     }
     

     You'll need to configure the following information in the response:

     • durationMinutes is the number of minutes logging should remain enabled.
     • rootLevel is the default level for all logs. For more information, refer to Logging Levels.

     • logLevels is a map object with logging classes as keys and logging levels as values.

       • For keys, refer to Logging Classes for commonly used logging classes.
       • For a list of available values, refer to Logging Levels.

Update Logging Configuration

Update the VA cluster configuration returned by the REST API to update the logging settings as needed.

1. Make the following call to the REST API to update the VA cluster's logging configuration. Replace {id} with the VA cluster's id attribute value recorded earlier.

   PUT /v3/managed-clusters/{id}/log-config

2. Submit your configuration changes to the REST API in a JSON body.

   • If the VA cluster did not already have a logging configuration and you received a 204 No Content response, you can create a new one.
   • If the VA returned a configuration, you can edit it to include the changes.

   The JSON body should be as follows:

   {
       "durationMinutes": 60,
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   

   Consider the following as you edit the JSON:

   • durationMinutes is the number of minutes logging should remain enabled.
   • rootLevel is the default level for all logs. For more information, refer to Logging Levels.

   • logLevels is a map object with logging classes as keys and logging levels as values.

     • For keys, refer to Logging Classes for commonly used logging classes.
     • For a list of available values, refer to Logging Levels.

   If the update was successful, the REST API should return a response similar to the following:

   {
       "clientId": null,
       "durationMinutes": 60,
       "expiration": "2020-12-15T19:13:36.079Z",
       "rootLevel": "DEBUG",
       "logLevels": {
           "sailpoint.connector.ADLDAPConnector": "DEBUG"
       }
   }
   

Observe Logging Changes

Approximately five minutes after you update the configuration, the VA cluster starts generating log files you can review. You can view the log files in ccg.log.

References

The tables in this reference section list information that can be helpful when creating the JSON body you'll use to configure the VA cluster's configuration file.

Logging Levels

Logging Classes

Documentation Feedback

Feedback is provided as an informational resource only and does not form part of SailPoint’s official product documentation. SailPoint does not warrant or make any guarantees about the feedback (including without limitation as to its accuracy, relevance, or reliability). All feedback is subject to the terms set forth at https://developer.sailpoint.com/discuss/tos.