Submitting Workbench Diagnostics Reports

When submitting a support ticket to Posit Support regarding an issue with Workbench, it is advisable to include a diagnostics report. Typically, the support team will request this report if it is not initially provided. Below, we outline an efficient method for submitting this report.

1. Access your server instance via SSH.

2. Execute sudo rstudio-server run-diagnostics. You’ll see a message indicating the diagnostics report has been generated, along with its file path, e.g., /tmp/rstudio-diagnostics/rsp-diagnostics-report-ip-172-31-91-112-240206091707.txt. Note the file path for later steps.

3. Compress the report file by running sudo gzip {file path}, substituting {file path} with the actual path provided in the message.

4. Transfer the compressed .txt.gz file to S3 using:

   aws s3 cp {file path}.gz s3://rstudio-workbench/logs/
   

   Remember to append .gz to the end of the file path to refer to the compressed archive, which will be located in the same directory as the original.

   To check if the AWS command line interface is installed, run aws --version. If you encounter errors related to botocore, updating the AWS CLI with pip3 install --upgrade awscli may resolve the issue.

5. Navigate to the S3 logs folder to download the log file.

6. For report submission:

   • Use Posit’s diagnostics report upload tool for larger files.
   • Attach the report directly to your support ticket for smaller files (likely under 50MB, though this isn’t a strict limit).