How to enable CSAPI debug logging in Protection Engine 8.2 and later on Linux

Products

• Protection Engine for Cloud Services
• Protection for SharePoint Servers
• Protection Engine for NAS

Issue/Introduction

CSAPI logging is intended for debugging, therefore it should be utilized only in case of necessity by request of a Symantec Support Engineer.

Resolution

Enabling CSAPI debug logging

1. Stop the SPE service.
   /etc/init.d/symcscan stop
    
2. Take a backup of the current symcscan.sh script.
   cd /opt/SYMCScan/bin
cp -p symcscan.sh symcscan.sh.org
    
3. To enable CSAPI debug logging, insert the following lines right after comment in symcscan.sh.
   

   CSAPI_DEBUG_LOG=/var/log/csapi.log
   CSAPI_DEBUG_LEVEL=5
   CSAPI_DEBUG_FILE_SIZE_LIMIT=104857600
   CSAPI_DEBUG_MAX_LOG_FILES=1
   export CSAPI_DEBUG_LOG
   export CSAPI_DEBUG_LEVEL
   export CSAPI_DEBUG_FILE_SIZE_LIMIT
   export CSAPI_DEBUG_MAX_LOG_FILES

    
4. To enable Stargate logging, at the end of the variable section , type:
   export STARGATE_DEBUG_LEVEL=5
   
   
5. Restart symcscan.
    /etc/init.d/symcscan start
    
6. Verify CSAPI logs are being created and log messages are yielded.

Disabling CSAPI debug logging 

1. Stop the SPE Service
    /etc/init.d/symcscan stop
    
2. Comment out the lines inserted in step 3 above or replace with the original script.
3. Restart symcscan
    /etc/init.d/symcscan start

Additional Information

Wrong platform?

For collecting SPE VERBOSE logs, CSAPI debug logs, and Stargate VERBOSE logs on Windows, see:

https://knowledge.broadcom.com/external/article/211023