3663088 - Best Practice: Use SAP Analytics Cloud Agent Survey Tool in Linux to Assist Support [How to]

When troubleshooting SAP Analytics Cloud Agent issues, support team and customers need to collect comprehensive diagnostic information including:

• Tomcat service configuration and installation details
• SAP Cloud Agent properties and configuration files
• System log files and error traces
• JDBC database drivers and connection configurations
• SAP Java Connector (JCo) files
• Database-specific SBO configuration files

Manual collection of this information is time-consuming, error-prone, and may result in incomplete data sets that delay issue resolution. In case of the server OS is Linux, the process might be more complicated and not easy to proceed.

• SAP Analytics Cloud (SAC) Enterprise
• Linux Operating System
• Apache Tomcat

NOTE: This survey tool is provided as-is. There is no official support for this script.

Use the SAP Cloud Agent Survey Tool to automatically collect all necessary diagnostic information in a structured format.

This tool creates a comprehensive report and organizes all relevant files for efficient troubleshooting. 

For Windows version, please check 3662076 - Best Practice: Use SAP Analytics Cloud Agent Survey Tool in Windows to Assist Support [How to]

Prerequisites:

• Linux bash
• root user access
• Only leave the tomcat which has cloud agent deployed running if have multiple tomcat installed
• zip or tar is installed

1. Download and Prepare the Tool

1. 1. Download the attachment and save the SAP Cloud Agent Survey script as CloudAgentSurvey.zip.
   2. Unzip and place the script cloud_agent_survey.sh in a directory where you have write permissions
   3. Ensure you have sufficient disk space (typically 50-200 MB depending on log file sizes)
   4. Grant execute access to this script. E.g. Execute command as the following:
      chmod 775 cloud_agent_survey.sh 
      
      
2. Execute the Survey Tool

   1. In Linux bash terminal, switch to root account or use sudo to execute:
      
      When using root, execute ./cloud_agent_survey.sh
      When using other OS user, execute either the following:

      • sudo ./cloud_agent_survey.sh

      • su - root -c './cloud_agent_survey.sh'

3. Review and Accept Terms

• 1. Read the detailed disclaimer and terms of use
  2. Type yes and press Enter key to confirm consent and proceed with data collection
  3. Type any other to cancel the operation

The tool will automatically:

• Detect running Tomcat processes and versions, check whether it has C4A_AGENT deployed. 
• If multiple Tomcat processes with C4A_AGENT deployed are found, only the 1st one will be proceed. 
• If no Tomcat running processes with C4A_AGENT deployed are found, the script will end without report generation.
• For the founded C4A_AGENT, locate Tomcat installation directory, Tomcat version and process id, full command line information.
• Extract Cloud Agent version information
• Copy configuration files and logs
• Identify and copy database drivers
• Generate comprehensive HTML report

Output Structure

The tool creates a Cloud Agent Survey folder containing the following. Also this generated folder will be compressed as a zip file or tar.gz file.
There will also be a log file created to save the whole process and output in the Linux terminal.

Cloud Agent Survey_<timestamp>/
├── Cloud_Agent_Survey_Report.html
├── [properties_file_name].properties
├── logs/
│   ├── *.log files
│   ├── *.trc files
│   ├── *.txt files
│   └── *.out files
├── JCo Drivers/
│   ├── sapjco3.jar
│   └── libsapjco3.so
├── JDBC Drivers/
│   └── *.jar files (database-specific)
└── SBO Files/
    └── *.sbo files (database-specific)

Generated Reports

HTML Report Sections:

1. Tomcat Information - Service status, version, installation path
2. Environment Variables - Properties file location and content
3. JDBC Drivers Information - Database driver analysis and file status
4. Logs Information - Complete log file inventory with file types
5. SAP JCo Files Information - Java Connector file verification
6. SBO Files Information - Database-specific configuration files

ZIP Archive:

• Automatically created using multiple compression methods
• Contains all collected files for easy sharing
• Filename format: Cloud Agent Survey_<timestamp>.zip

Troubleshooting the Tool

Common Issues and Solutions:

Issue: "No Tomcat processes found"

• Solution: Ensure Tomcat service is running and verify process names match expected patterns

Issue: "Properties file not found"

• Solution: Set SAP_CLOUD_AGENT_PROPERTIES_PATH environment variable or manually locate the properties file

Issue: "Neither zip nor tar command found. Archive not created."

• Solution: The compress command zip or tar cannot be executed therefore the compress zip or tar.gz file cannot be created. Howevr, the tool will still create individual files in the survey folder; manually compress the folder if needed

Issue: "Access denied errors"

• Solution: Run Command Prompt as root or using sudo to make sure there are appropriate file system permissions

Security and Privacy Considerations

⚠️ Important Security Notes:

• The collected data may contain sensitive configuration information
• Review all files before sharing with external parties
• Ensure compliance with your organization's data handling policies
• The tool operates in READ-ONLY mode and makes no system changes
• Remove or redact sensitive information (passwords, connection strings) before sharing

Best Practices

1. Before Running:

   • Stop any non-essential processes to ensure clean log capture
   • Verify sufficient disk space is available
   • Document any recent changes or error conditions

2. After Collection:

   • Review the HTML report for completeness
   • Verify all expected components are present
   • Test ZIP file integrity before sharing

3. For Support Cases:

   • Include the complete ZIP file with your support request
   • Reference this KBA in your case description
   • Provide additional context about the specific issue being investigated

Additional Information

Script Capabilities:

• Automatic Tomcat version detection and path resolution
• Intelligent database driver identification from properties file
• Comprehensive log file analysis with type categorization
• Multiple ZIP compression methods for maximum compatibility
• Detailed HTML reporting with visual status indicators

File Size Considerations:

• Log files can be large (10MB-1GB+) depending on system activity
• JDBC drivers typically range from 1-50MB per driver
• Complete validation package usually ranges from 1-200MB

3662076 - Best Practice: Use SAP Analytics Cloud Agent Survey Tool in Windows to Assist Support [How to]

sac, bash, linux, redhat, suse, log, glf, businessobjects, c4a, scc, agent, cloudagent , KBA , LOD-ANA-AQU , Import Data Connections (Acquiring Data) , LOD-ANA-AQU-BW , Data Acquisition from BW , Problem