Capturing SPE, CSAPI and Stargate logs for Protection Engine 8.2 or later

book

Article ID: 211023

calendar_today

Updated On:

Products

Protection Engine for NAS Protection Engine for Cloud Services

Issue/Introduction

Procedure to configure logging parameters in Symantec Protection Engine environment to capture Stargate, CSAPI and SPE required for troubleshooting of any issue. 

Resolution

  1. Stop SPE service.
  2. Enable SPE detail logging by Modifying configuration.xml from the SPE installation directory, turn ON the local logs to details <LogLocal logfilestokeep="0" loglevel="5"/>
  3. Enable CSAPI detail logging by following steps mentioned in article
    1. If For Windows: 
      https://knowledge.broadcom.com/external/article/157519/how-to-enable-csapi-debug-logging-for-pr.html
    2. If For Linux:
      https://knowledge.broadcom.com/external/article/164895/how-to-enable-csapi-debug-logging-in-pro.html
  4. Enable Stargate detail level logging
    1. If For Windows:
      1. Extract attached Stargate.zip
      2. Browse and locate inside extracted files Stargate\Win64 and make note of file full path.
      3. Run TraceView.exe. Traceview is part of Windows Driver Kit (WDK). It can be obtained from http://www.microsoft.com/en-au/download/details.aspx?id=11800.
      4. Configure "traceview" to capture stargate logs.
        1. Click "File" ->> "Create New Log Session"
        2. Click "Add Provider"
        3. Select "CTL (Control GUID) File
        4. Browse to the location of Stargate\Win64 and choose all *.ctl files then click "Open"
        5. Choose "Select TMF Files" then click "OK"
        6. Click "Add" and choose all *.tmf files then click "Open"
        7. Click "Done"
        8. Click "Next" to configure the "Log SessionOptions":
          1. Disable "Real Time Display"
          2. Enable "Log Trace Event Data to File" and change Log File Name to a location with plenty of drive space.
          3. Click "Advanced Log Session Options"
            1. Go to the "Log Session Parameter Options" tab.
            2. Set "Buffer Size" and "Sequential Buffer Size (MB)" to 0 so that the log file size is not limited.
            3. Click ok.
        9. Click "Finish" 
    2. If For Linux:
      1. Open symcscan.sh in a text editor and add the following at the end of the variable section at the beginning of the file (see step 3.2):
        1. export STARGATE_DEBUG_LEVEL=5
  5. Start the Symantec Protection engine service and replicate the problem.
  6. Provide copies of session1.etl (or your configured filename) if Windows or a copy of the logs directory from /opt/SYMCScan/bin/definitions/Stargate/logs if Linux, CSAPI Debug log (csapi*.log) defined in step 3, and a copy of the SPE logs from the day of testing from /log inside the SPE installation folder

Attachments

1624476530163__Stargate.zip get_app