Logs are a very useful way to monitor workspace activities in detail. They can also be very helpful for debugging in case of failures or errors. This document will guide you through the available settings and how to view the logs.
Configure logs
To access this page, go to Administration > Workspace > Settings > Logs. Modify the following settings:
Field | Description |
|---|---|
Log Level | From the drop-down menu, select the level of logs to receive. The options are:
|
Log View Limit | Enter a number to limit the number of logs displayed. |
Trace method calls | Enable this option to trace every method call. |
Trace method filter | Enter specific text to filter the traced method calls. The text here is evaluated as a regular expression ( |
Trace subscription calls | Enable this option to trace every subscription call. |
Trace subscription filter | Enter specific text to filter the traced subscription calls. The text here is evaluated as a regular expression ( |
Log Exceptions to Channel | Enter the name of an existing channel to receive all captured exceptions. Leave empty to ignore exceptions. |
Configure Prometheus
If you have set up a Prometheus server for monitoring purposes, you can integrate it with Rocket.Chat. On the workspace’s Logs page, update the following Prometheus settings:
Field | Description |
|---|---|
Enable | Enable this option to activate Prometheus monitoring. |
Port | The port to listen to. |
Reset Interval (ms) | Enter the time (in milliseconds) when the connection should be reset. |
Collect NodeJS GC | Keep this option enabled always to activate NodeJS garbage collector. It’s useful for debugging. |
API: Track User Agent | Enable this option to track the API calls of user agent. |
If you enabled monitoring when deploying your Rocket.Chat workspace, the Prometheus settings were configured automatically. Do not modify them, as this may disrupt monitoring.
View workspace logs
Once your settings are configured, you can check your workspace logs and analytics reports from Administration > Workspace > Reports.
The Reports page has two tabs:
Logs: The Logs tab allows you to review detailed information configured for logging purposes. It is particularly useful for troubleshooting issues or monitoring your server's ongoing activity and status.
Analytic reports: Rocket.Chat collects anonymous usage data, such as feature usage and session lengths, to improve the product for everyone. We ensure that the data we gather doesn’t identify you personally or involve any sensitive information. The Analytics Report tab explains exactly what data we collect and shows that we're committed to being open and trustworthy.
If you are not an admin user, ensure you have the View Logs permission to view the workspace logs. To assign this permission to a role, go to Administration > Workspace > Permissions. Search for the View Logs permission and select the checkbox for the role that you want to assign this permission to.
Configure troubleshooting
Configure how troubleshooting is handled in your workspace.
To access this section, go to Administration > Workspace > Settings > Troubleshoot.
We recommend these settings be altered only with the guidance of the Rocket.Chat Development or Support Teams. Do not make any changes without assistance or you may encounter disruptions in the workspace functionality.
Field | Description |
|---|---|
Disable Notifications | Enabling this setting disables the notifications system completely. Sounds, desktop, mobile, and email notifications immediately stopped. |
Presence broadcast disabled internally | This indicates whether the presence broadcast is disabled automatically. This can occur in workspaces with no premium license and over 200 concurrent users. |
Disable Presence Broadcast | Enable this setting to prevents all instances from sending the users' status changes to their clients, keeping all users with their presence status from the first load. |
Disable Instance Broadcast | Enabling this option prevents the Rocket.Chat instances from sending events to the other instances. It may cause syncing problems and unexpected behavior. |
Disable Sessions Monitor | Enabling this setting stops the processing of user sessions, causing the statistics to stop working correctly. |
Disable Livechat Activity Monitor | Enabling this setting stops the processing of Livechat contacts sessions, causing the statistics to stop working correctly. |
Disable Data Exporter Processor | Enabling this setting stops the processing of all export requests from users, so they will not receive the link to download their data. |
Disable Teams mention | Enabling this setting disables the teams mention feature, preventing users from mentioning a team by name in a message. |
Force browsers to clear networking cache based on version change | Enabling this setting allows browsers to clear the cache based on the provided version. If the value provided is not empty and different from previous one, the browsers will try to clear the cache. This setting should not be set for a long period of time since it affects the browser performance, clear it as soon as possible. |