Skip to main content
Version: 2.0 (Preview)

Managing the Configuration

You manage the configuration of your probes in the Surfmeter Dashboard. Probes download it from the server. You do not have to log in to them or edit any files.

Measurement and Schedule Configs​

Each probe uses two configurations:

  • A measurement config (publicConfig.json) lists the studies, that is, what to measure.
  • A schedule config (automatorConfig.json) defines when these studies run, and with which options.

Each schedule config belongs to one measurement config. See Client Configuration for how to create and publish them in the dashboard. To learn about the formats, see the references for the Public Config and Automator Config V2.

Schedule Configs​

In the dashboard, a schedule config contains schedule entries and global settings, such as the time zone, random start offset, study options, and environment variables. See Scheduling Studies for the available settings.

Assigning a Configuration to Clients​

Important: Publishing does not assign a configuration

A published configuration must be assigned to clients before they can use it. Assigning a schedule config also assigns its measurement config.

A client gets its configuration from the first of these sources that applies:

  1. A manual assignment to the client, or an assignment to its client group.
  2. A schedule config marked as a template, whose client tags all match the tags of the client. If multiple templates match, the highest priority wins. This is how you configure new probes automatically.
  3. The default config of the data owner.

Manual and group assignments are not changed when the tags or templates change. See the Configuration tab of a client in the dashboard for what it is currently using.

To disable scheduled measurements on a client, assign it a schedule config without entries.

How Probes Get the Configuration​

The daemon checks for a new configuration every 15 minutes. When there is one, it validates and installs it, and applies the new schedule without a restart. To change the frequency, set updates.config.schedule in the schedule config (in the dashboard, under Global Settings).

To get the configuration immediately, run:

surfmeter config update

If a configuration is invalid, the probe keeps the last one that worked.

Checking the Configuration on a Probe​

surfmeter config show              # Show both configurations
surfmeter config show schedule     # Show only the schedule config
surfmeter config show measurements # Show only the measurement config
surfmeter config show --paths      # Show which files are in use
surfmeter daemon status            # Show the schedule the daemon is running

Secrets such as service logins are masked in the output, unless you add --showSecrets.

Service Logins​

Some studies need logins for video services. Store them under Service Logins in the dashboard.

Bringing an Existing Configuration into the Dashboard​

To move a configuration from a probe to the dashboard, use Import JSON. See Moving configurations between the dashboard and Automator.

Local Configuration​

If you need to maintain the configuration on the probe itself, see Local Configuration.