Skip to main content

Monitoring

The Supra Server provides two monitoring options: a Grafana dashboard running on the server itself and cloud-based metrics viewable directly in Box. Choose the approach that fits your workflow — or use both.

ApproachAccessBest for
Grafana (server-side)http://<server-ip>:3000Detailed historical graphs, system resources
Box Monitoring card (cloud)Device detail → Supra tabQuick per-client metrics view from anywhere

Grafana Dashboard (Server-Side)

Installation

  1. Navigate to the Supra Server device in Box.
  2. Go to the Scripts section (or use the Supra tab if a monitoring action is available).
  3. Execute the Supra Server - install-monitoring Custom Script.
  4. Wait for the installation to complete.
  5. The Grafana URL will be displayed in the script output (e.g., http://192.168.3.202:3000).

Accessing the Dashboard

After installation, access the monitoring dashboard at:

http://<supra-server-ip>:3000

Default credentials:

FieldValue
Usernameadmin
Passworduser-defined
warning

Change the default credentials after first login via the Grafana user settings.

Pre-installed Dashboard

The monitoring stack comes with a pre-installed Supra Dashboard that displays:

MetricDescription
Stream statusActive streams and connected clients
FramerateRendering frames per second
BitrateStream bandwidth usage
Rendering latencyTime from render to display
Rendering startsNumber of rendering session initiations
Process CPU usageCPU consumption by Chromium, Supra Server Daemon, and screen sessions
Machine CPU & MemoryOverall system resource utilization

Monitoring Stack Components

The monitoring solution runs as a set of containers on the Supra Server:

ContainerPurpose
supra-server-monitoring-grafanaGrafana dashboard UI
supra-server-monitoring-prometheusMetrics collection and storage
supra-server-monitoring-telegrafSystem metrics agent
supra-server-monitoring-node-exporterNode-level metrics exporter
supra-server-monitoring-process-exporterProcess-level metrics exporter

Network Requirements

The monitoring dashboard is accessible on port 3000 of the Supra Server. Ensure this port is reachable from your management network if you need remote access to the dashboard.

Cloud Monitoring via Box

You can view real-time Supra metrics directly in Box without accessing the server's network. The Monitoring card on the Supra tab collects Prometheus metrics from the Supra Server on demand and displays per-client performance data.

Accessing the Monitoring Card

  1. Navigate to the Supra Server device in Box.
  2. Open the Supra tab.
  3. Scroll to the Monitoring card (visible when the Supra Server is installed).

Server Metrics

The top of the Monitoring card shows server-level totals:

StatisticDescription
Connected ScreensNumber of active screen rendering sessions
Connected ClientsNumber of client devices currently connected

Client Metrics Table

Below the server totals, a table lists every device in the same Location with the following columns:

ColumnDescriptionFormat
DeviceDevice name (links to the device detail page)Text
ConnectedWhether the device was matched to metrics dataYes / No tag
Frame RateCurrent rendering frame rate30 fps
Byte RateStream bandwidthAuto-scaled (B/s, KiB/s, MiB/s, GiB/s)
LatencyRendering latencyAuto-scaled (ms, s, min)
ResolutionClient screen resolution1920 × 1080 px
Last ConnectedWhen the client last connected to the Supra ServerLocalized date and time
Last InteractionWhen the client last received interaction inputLocalized date and time
tip

If a device shows No in the Connected column, it means no matching metrics were found for that device in the latest collection. The device may be offline or not yet connected to the Supra Server.

Refreshing Metrics

  • Manual refresh — Click the Refresh button in the card header to trigger a new metrics collection.
  • Auto Refresh — Toggle the Auto Refresh switch to collect new metrics every 30 seconds. A countdown indicator shows the time until the next collection.
note

Auto Refresh is not persistent — it resets to off when you navigate away from the page or refresh the browser.

How Device Matching Works

The Supra Server identifies connected clients by a hashed device identifier. Box matches each device in the Location to its metrics by computing the same hash from the device's unique ID (DUID). Devices that cannot be matched — for example, because they are offline or not connected to the Supra Server — appear in the table without metrics data.

Raw Metrics

You can retrieve raw Prometheus metrics from the Supra Server daemon without installing the full monitoring stack by running the Supra Server - get-metrics Custom Script.

  1. Navigate to the Supra Server device in Box.
  2. Go to the Scripts section.
  3. Execute the Supra Server - get-metrics Custom Script.
  4. The script output will contain raw Prometheus metrics in text format.

The script queries the daemon's built-in metrics endpoint and returns the data as plain text. On failure (e.g., if the daemon is not running), it returns an error message and a non-zero exit code.

info

This script does not require the Grafana monitoring stack to be installed. It reads metrics directly from the Supra Server daemon.

Use raw metrics when you want to:

  • Integrate Supra metrics into an external monitoring system (e.g., your own Prometheus or Datadog instance).
  • Perform a quick health check of the Supra Server daemon.
  • Collect metric snapshots for diagnostics or support requests.