Whilst working through support tickets with our support team, you may often be asked to run the "diagnostics script" for our team to be able to assist in troubleshooting. The diagnostics script command for Posit Workbench looks like this:
sudo rstudio-server run-diagnostics
What is the diagnostics script?
The diagnostics script goes into your Posit Workbench's server and collects crucial information pertaining to your installation. This type of information includes:
Category |
Information |
| Operating System Information | Details about your operating system (such as Linux Distribution, version, etc). |
|
Mounts |
Information about any storage mounts that exist on your server. |
| R installation | Details about the version of R that you're using and its location. |
| Posit Workbench | Information about the version of Posit Workbench that you are using |
| Rstudio Server config files | The contents of any configuration files that exist on the server. |
| License manager status | The current status of your Posit Workbench license. |
| Machine Environment | Details about your Linux server's machine environment. |
| R environment outside of RStudio | The details of your R environment isolated from the RStudio IDE. |
| Rstudio Messages in the System Log | Collects the log for any messages in either var/log or var/messages which contain the "RStudio" string. |
| RStudio Server Log | Collects the log information from /var/lib/rstudio-server/monitor/log/rstudio-server.log |
| Job Launcher Debug Logs | Logs specific to the job launcher |
| Java Environment | Details about your Java environment |
| Network Connections | Current network connectivity status |
This script collects a large amount of information and is pertinent to helping our support engineers in resolving any issues that you may have. Depending on your organization, you may wish to sanitize certain information that you would rather not send in an email - this is totally fine. If you do sanitize any information from the script, please let our support engineers know that you have done so, just so that we are aware.
Submitting the diagnostics file
After running the diagnostics script, you will receive an output that looks similar to the below:
cecil@RStudioWorkbenchServer:/home/cecil# sudo rstudio-server run-diagnostics
Generating diagnostics report ...
Diagnostics report has been generated: /tmp/rstudio-diagnostics/rsp-diagnostics-report-RStudioWorkbenchServer-211021124733.txt
Please note that the diagnostics report may contain sensitive data.
You may wish to sanitize data that you feel is sensitive, but please us know if you have done so.
The output will provide you with the location of where your diagnostic report is saved.
Now, you can send this diagnostics file alongside some details about any issues that you are experiencing, to our support team. The file can be sent via FTP, SCP, or you can copy the contents manually from the file itself.
Please note that the output is generally quite large. If you have any issues with sending it through to our support team, I would suggest using our diagnostics upload tool which can be found here:
https://posit-support.shinyapps.io/upload/
Support Ticket
If you still have issues after completing the above, you can always lodge a support ticket, where our group of friendly, and incredibly knowledgeable staff can assist with any issues that you may be having. You can submit a ticket here:
https://support.posit.co/hc/en-us/requests/new