Generating a Diagnostic Report for On-Prem Server

If you're experiencing issues with your Surfly On-Prem deployment, our Support team may ask you to generate a diagnostic report. This report collects information about your server and Surfly installation to help us troubleshoot problems more efficiently.

What information is included?

The diagnostic report includes:

Operating system and hardware information
System service logs
Surfly usage metadata
Surfly account and configuration settings

The report does not contain information about user activity inside Surfly sessions, such as personally identifiable information (PII) or session content.

▶️ Generate the Diagnostic Report

Execute the following command on your Surfly server:

curl -O https://raw.githubusercontent.com/surfly/on_prem_log_collection/main/generate_report.sh && chmod +x generate_report.sh && ./generate_report.sh

This will:

Download the latest diagnostic script
Make the script executable
Run the script immediately

📁 Report Output

Once the script completes, you will see output similar to:

Local report generated: /path/to/surfly_diagnostic_full.html

The generated HTML file contains the complete diagnostic report.

🔗 Generate a Shareable Link (Optional)

At the end of execution, you will be prompted:

Would you like to export this report to a shareable link? (y/n):

Enter y to generate a temporary public link. This option may not be available depending on your network configuration.
Enter n to keep the report on your local server. You can then send the generated HTML file directly to Surfly Support.

Send either:

the generated HTML file, or
the shareable link (if you created one)

to the Surfly Support team as requested.

🔐 Security

The diagnostic script automatically masks sensitive information before generating the report, including:

Passwords (for example *_PASSWORD and *_PASS)
Tokens and secrets (for example *_TOKEN and *_SECRET)
API keys and credentials
Database credentials (for example PG_EXTERNAL_USER_PASS)
Mail server credentials

If your organization has additional security requirements, we recommend reviewing the report before sharing it.

❗Troubleshooting

If the script does not run successfully:

Verify that curl is installed on the server.
Check the script for syntax errors:
```
bash -n generate_report.sh
```
Confirm that the script downloaded successfully and that the file contains the shell script rather than an HTML error page.