How to enable debug logging for vAPI Endpoint service

Products

VMware vCenter Server

Issue/Introduction

When troubleshooting issues with VAPI Endpoint service, we can enable debug logging. All the logs are under /var/log/vmware/vapi/endpoint folder.

Environment

VMware vCenter Server 8.0

VMware vCenter Server 7.0

Resolution

Important: Ensure that you back up the original configuration files and that the changes are reverted to INFO after collecting the data to avoid performance impacts.

To enable debug level logging for VAPI Endpoint Service

For vCenter 8.0 and above

Edit /etc/vmware-vapi/endpoint-log4j.properties and update appender.endpointInfo.filter.threshold.level=info to appender.endpointInfo.filter.threshold.level=debug

Add the below lines to the /etc/vmware-vapi/endpoint-log4j.properties

# appender for all log requests with level >= DEBUG

appender.endpointDebug.type=RollingFile

appender.endpointDebug.name=endpoint.debug.file

appender.endpointDebug.filter.threshold.type=ThresholdFilter

appender.endpointDebug.filter.threshold.level=debug

appender.endpointDebug.fileName=${env:VMWARE_LOG_DIR}/vmware/vapi/endpoint/endpoint-debug.log

appender.endpointDebug.filePattern=${env:VMWARE_LOG_DIR}/vmware/vapi/endpoint/endpoint-debug.log.%i.gz

appender.endpointDebug.append=true

appender.endpointDebug.policies.type=Policies

appender.endpointDebug.policies.size.type = SizeBasedTriggeringPolicy

appender.endpointDebug.policies.size.size=20MB

appender.endpointDebug.policies.minSize.type = OnStartupTriggeringPolicy

appender.endpointDebug.policies.minSize.minSize=0

appender.endpointDebug.strategy.type = DefaultRolloverStrategy

appender.endpointDebug.strategy.max = 150

appender.endpointDebug.strategy.fileIndex = min

appender.endpointDebug.layout.type = PatternLayout

appender.endpointDebug.layout.pattern=%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX}{GMT} | %-5.5p | %-25.50t | %-30.50c{1} | %-36X{opId} | %m%n

#sets vapi logger to debug

logger.vapi.name=com.vmware.vapi

logger.vapi.level=debug

logger.vapi.appenderRef.endpointDebug.ref=endpoint.debug.file

For vCenter 7.0 and above

# appender for all log requests with level >= DEBUG

log4j.appender.endpoint.debug=com.vmware.log4j.appender.NonAppendingRollingFileAppender

log4j.appender.endpoint.debug.append=true

log4j.appender.endpoint.debug.encoding=UTF-8

log4j.appender.endpoint.debug.threshold=DEBUG

log4j.appender.endpoint.debug.file=/var/log/vmware/vapi/endpoint/endpoint-debug.log

log4j.appender.endpoint.debug.maxFileSize=20MB

log4j.appender.endpoint.debug.maxBackupIndex=150

log4j.appender.endpoint.debug.layout=org.apache.log4j.PatternLayout

log4j.appender.endpoint.debug.layout.conversionPattern=%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} | %-5.5p | %-25.50t | %-30.50c{1} | %-36X{opId} | %m%n

# vAPI logger

log4j.logger.com.vmware.vapi=DEBUG, endpoint.debug

Note: The new configuration changes takes a minute to load. Service does not require restart to pick the changes.