Configure Workspace Logs

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: 0 - Errors Only: Displays the errors only. 1 - Errors and Information: Displays various workspace activities and errors. 2 - Errors, Information and Debug: Displays debugging details.
Log View Limit	Enter a number to limit the logs to be 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 (`new RegExp('text')`). Keep it empty to show a trace of every call.
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 (`new RegExp('text')`). Keep it empty to show a trace of every call.
Log Exceptions to Channel	Enter an existing channel’s name 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 settings:

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: When this option is enabled, NodeJS garbage collector is activated.
API: Track User Agent: If this option is enabled, API calls of the user agent are tracked.

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 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.

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.