Managing Clients¶

The Clients page lists all measurement clients registered with your Surfmeter instance.

Client list¶

The table shows each client with its label, UUID, type, last measurement time, and status. You can sort and filter the table. Use the Client Type filter to show only clients of certain types. A toggle lets you show or hide disabled and unregistered clients.

The client type shows which Surfmeter product the client runs, for example Surfmeter Automator, Surfmeter Lab, Android Quality SDK, or Surfmeter Media Toolkit.

Creating a new client¶

Use Clients > Create Client in the sidebar, or the Create Client button on the client list, to set up a new measurement probe. The page guides you through downloading the software and registering the client. Viewers cannot create clients.

1. Under Client Configuration, select the Registration Key to use. Optionally, enter a Label and Tags for the new client.
2. Turn on Use Docker if you want to run the client in Docker. Otherwise, the page shows the steps for a native installation.
3. Under Available Software, copy the commands to download and unpack the latest software versions for your organization. For a native installation, this includes Surfmeter Automator, Surfmeter Lab, and the configuration. For Docker, it includes only the configuration.
4. Follow the steps under Installation Instructions. For a native installation, you run the setup script and then the registration command. For Docker, the page shows a ready-made docker-compose.yml file with your registration key filled in.

All commands are filled in with the values you selected and can be copied with one click. For more details, see the Native Setup Guide and Docker Setup Guide.

Client details¶

Click on a client to open its detail page. The page has the tabs Client Information, Measurements, and Anomalies. Surfmeter Automator and Surfmeter Lab clients also have a Configuration tab.

The Client Information tab shows:

• The client's UUID, type, creation date, and last measurement date.
• Its current status (registered, disabled).
• The registration key it was registered with.
• Assigned tags and group memberships.

The System Health section shows the latest CPU, memory, connection, and filesystem status reported during a study run. See Fleet Health for health states and thresholds.

The Measurements tab lists recent measurements from this client, with links to their detail pages. The Anomalies tab lists the anomalies detected for this client.

Editing a client¶

On the detail page, you can edit the client's label and tags. Changes are saved immediately.

Notification preferences¶

Use the Notifications button on the client detail page to suppress selected notifications for that client:

• Mute anomalies stops the client from producing new anomaly events.
• Mute offline notifications suppresses offline and back-online emails.
• Mute system health notifications suppresses warning, critical, escalation, and recovery emails for CPU, memory, and disk health.

All three mute switches are off by default. The Notifications button turns yellow when at least one mute is active.

These client settings apply in addition to each user's choices under Settings > Notifications. An email is sent only when the user subscribes to that notification type and the client has not muted it.

Editors, administrators, and organization administrators can change notification preferences for clients owned by their organization. The button is not available to viewers or on shared clients. The owning organization's settings also apply when it shares the client with another organization.

Adding a client to groups¶

Use the "Add to Group" action to assign the client to one or more client groups. A dialog shows the available groups.

ISP contract¶

The detail page also shows the client's ISP contract, if any: the ISP, contract name, connection speeds, connection type, monthly price, and validity period. Users with permission can set up, edit, or remove the contract from here.

Disabling a client¶

If a client should no longer perform measurements, you can disable it from the detail page. The Dashboard provides the appropriate unregistration command for your setup (including Docker-based installations). You can also disable a client manually.