Grafana

Prev Next

Grafana is an open-source analytics and visualization platform used to monitor metrics and system performance. It provides charts, graphs, and alerting capabilities when connected to supported data sources such as Prometheus.

Grafana can be deployed using Docker or Docker Compose.

The Grafana dashboards for Rocket.Chat visualize several application metrics, including:

  • General totals: Users online/away, DDP users, and activity differences over time.

  • Metrics: Request counts and total size per instance.

  • Node.js: Active handles, requests, event loop lag, heap usage, and garbage collection metrics.

  • DDP Rate Limiter: Rate limits by method, type, user ID, and connection ID.

  • Rocket.Chat Data: Messages sent, user presence, sessions, oplog activity, push queue, total users, total rooms, and notification metrics.

  • Meteor: Method execution time, total method calls, and calls per minute.

  • Subscriptions: Subscription processing time and calls per minute.

  • Callbacks & Hooks: Callback and hook execution metrics and frequency.

  • REST API: API execution time and call rate.

Grafana dashboards

The Rocket.Chat Metrics GitHub repository is deprecated. To access the dashboards, use the dashboards available in the Grafana dashboard directory.

Available dashboards include:

If you want to download a dashboard JSON file directly, use the following URL format:

https://grafana.com/api/dashboards/<dashboard_id>/revisions/<version>/download

Where:

  • <dashboard_id>: The dashboard ID.

  • <version>: The dashboard revision version.

The dashboard ID can be found in the Grafana directory URL (for example, 23428), and the revision version is listed in the Revisions section of the dashboard page.

To view Rocket.Chat’s published dashboards, visit the Grafana dashboard directory.