Enabling OIDC debug logging for Cloud Director

Products

• VMware Cloud Director

Issue/Introduction

This article provides instructions for enabling debugging logging for OIDC.

Symptoms:
It may be useful to enable debug logging for OIDC when attempting to configure OIDC for Cloud Director.

Environment

VMware Cloud Director 10.x

Cause

This may help diagnosing any OIDC issues.

Resolution

Modify the log4j.properties file on the cloud cells to include the following lines:

/opt/vmware/vcloud-director/etc/log4j.properties

log4j.logger.com.vmware.ssdc.backendbase.oauth.OIDCServiceImpl=TRACE, test.trace.logging
log4j.logger.com.vmware.ssdc.backendbase.usermanagement.OrgMemberProvider=TRACE, test.trace.logging
log4j.logger.com.vmware.vcloud.ui.h5auth.OAuthAuthenticationSuccessHandler=TRACE, test.trace.logging
log4j.appender.test.trace.logging=org.apache.log4j.RollingFileAppender
log4j.appender.test.trace.logging.File=logs/vcloud-trace.log
log4j.appender.test.trace.logging.MaxFileSize=10240KB
log4j.appender.test.trace.logging.MaxBackupIndex=9
log4j.appender.test.trace.logging.layout=com.vmware.vcloud.logging.layout.CustomPatternLayout
log4j.appender.test.trace.logging.layout.ConversionPattern=%d{ISO8601} | %-8.8p | %-25.75t | %-30.50c{1} | %m | %x%n
log4j.appender.test.trace.logging.threshold=TRACE

Additional Information

Impact/Risks:
This is only meant for debugging short term issues.  Once the issue is ready to be diagnosed, please disable the trace logging by removing the lines from the log4j.properties file again.  Removing the lines setting the trace logging to on will keep the amount of information in the logs to a normal level.