Enable Debugging and Gather Logs - Central Credential Provider

cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 
Secrets Management Articles
3 min read
L0 Member
No ratings

Question

How do I enable debugging and gather logs for the Central Credential Provider?

Answer

The procedure associated with raising debug levels for logging  for CCP ( Central Credential Provider)  consists of two parts, as below: 

i. Enable debug  for CP

ii. Enable debug  locally on the CCP server 

 

Details for each part can be found as below - 

i. Enable debug for CP

a. For  'Privileged Cloud' aka pcloud deployments, use below linked KBA to perform this step - https://community.cyberark.com/s/article/Configure-Debugging-for-Privilege-Cloud-Connected-Credentia... 

b. For Self-Hosted Vault deployments please do the following - 

Use the 'PrivateArk Client' to open the 'AppProviderConf' safe and create a copy of the "main_appprovider.conf.[Platform].[Version]" stored in the root folder and call it _debug.
For example, if you're using a Windows 9.7 provider, you would copy "main_appprovider.conf.Win64.9.70" to "main_appprovider_debug.conf.Win64.9.70".
Open this new file and uncomment/set the following debug parameters: 

[Debug] 
CacheDebugLevels=0,1,2 
AppProviderDebugLevels=0,1,2,3,4,5 
ProtocolDebugLevels=0,1,2 

ii. Enable debug locally on the CCP server 

1. Edit the local 'basic_appprovider.conf' configuration file

("C:\Program Files\CyberArk\ApplicationPasswordProvider\basic_appprovider.conf" by default) by changing the 'AppProviderVaultParmsFile' parameter in the file, for example: AppProviderVaultParmsFile=main_appprovider_debug.conf.Win64.9.70

 

2. Enable debug for 'AIMWebService'

a. For version 12.6 and later, please refer to documentation:

https://docs.cyberark.com/credential-providers/Latest/en/Content/CCP/Configure_CCPWindows.htm

In C:\inetpub\wwwroot\AIMWebService\web.config, find the following section 

<log4net>
      ....
        <root>
            <level value="INFO"/>
            <appender-ref ref="RollingLogFileAppender"/>
        </root>
</log4net>

Change the value "INFO" to "ALL".

b. For version 12.4 and earlier, follow the steps below:

Open the file C:\inetpub\wwwroot\AIMWebService\web.config 
Find the line:  <add name="AIMWebServiceTrace" value="0"/> 
Set Value to 4 (verbose).


Ensure the "logs" folder is created and has the appropriate permissions. This is a manual step that may have already been done on your install. Go to C:\inetpub\wwwroot\AIMWebService and create a new folder, called "logs"  .Right click the logs folder → Properties → Security → Edit 
There should already be an inherited permission for the IIS_IUSRS group (name may be different depending on your app pool setup). 
Check the boxes for Allow Modify and Allow Write for IIS_IUSRS. 

 

IMPORTANT:  To make the configuration changes take effect do the following - 

** Restart the 'Idira Application Password Provider' Service.
** From an elevated command prompt, run "iisreset".

Log Collection 

Rerun the web call that failed, and then please upload the following to the case:

a. 'Credential Provider' logs 

 \Program Files\CyberArk\ApplicationPasswordProvider\Logs:
APPconsole.log
APPtrace.log
APPaudit.log

b. AIMWebService Logs

 \inetpub\wwwroot\AIMWebService\logs\AIMWSTrace.log

c. IIS logs
\inetpub\logs\LogFiles\W3SVC1' on CCP server(s)

 

d. Install Logs ( if the troubleshooting is related to Installation process)

In the %TEMP% directory, there will be at least one folder that's a few random characters and then ".tmp", for example "VSDDA1F.tmp". In that directory should be an install.log for the CCP install. Example: C:\Users\<username>\AppData\Local\Temp\VSD51C7.tmp

Rate this article: