Skip to main content

Studio Watchdog Management

The "Watchdog" page is used to save Watchdog service connections in Studio, perform connection tests, check running status, open backup drawers, and serve as a target source for uploading and downloading projects from the gateway.

Page entry

Menu path: Studio Web > Watchdog.

Studio Watchdog Page

Area or ActionsInstructions
Add Gateway ServiceOpen the Service Configuration drawer.
Card ViewDisplays service name, address, Watchdog status, and GatewayRuntime status.
List ViewDisplays Watchdog services in a tabular format, suitable for multi-gateway management.
TestImmediately test the connection from Studio to Watchdog.
BackupOpen the backup drawer of the target Watchdog.
EditChange the service name, address, port, username, and password.
DeleteDelete the Watchdog connection configuration saved in Studio without deleting items or backups on the target gateway.

Meaning of Status

StatusExplanationHandling Suggestions
Watchdog OnlineStudio can access the Watchdog API and read states.You can continue uploading projects, downloading projects, or viewing backups.
Watchdog offlineStudio cannot access Watchdog services.Check addresses, ports, firewalls, account passwords, and whether services are running.
Gateway RunningWatchdog detects that GatewayRuntime is running.It is still recommended to back up before uploading or restoring data.
Gateway has stopped being onlineWatchdog, but GatewayRuntime is not running.View logs or launch the gateway in the Watchdog Web dashboard.
Gateway unknownWatchdog offline or status read failure.First, restore the Watchdog connection.

Add or Edit Gateway Services

Click "Add Gateway Service," or click Edit in an existing service to open the service configuration drawer.

Added Gateway Service Drawer

Configuration ItemsDescription
Service NameThe name displayed in Studio is recommended to include site or production line information.
Service Addressthe IP or domain name of the Watchdog service, with the port entered in the "Service Port" section. Regular HTTP IPs are officially supported, for example, entering 192.168.1.20.
Service PortThe port used by Studio to access Watchdog Web/API, range 1-65535. Bundled Watchdog commonly used 6200; If the Watchdog port has been modified on site, fill in the actual port. Enter the Watchdog port here, do not enter the GatewayRuntime Web/API port, and do not repeatedly enter the port in the service address.
UsernameWatchdog login account.
PasswordWatchdog login password.
SaveAdd or update connection configurations.
CancelClose the drawer without saving.

After saving, it is recommended to click "Test" immediately. A successful test only means Studio can access Watchdog; Whether the target GatewayRuntime can run properly depends on the gateway status and Watchdog logs.

Studio automatically retrieves Watchdog's one-time RSA-OAEP-SHA256 public key challenge, encrypts the saved password, and exchanges it for a Bearer session. Connection testing, status polling, upload/download, and backup management all use Bearer, without the need to configure Basic authentication. If the Watchdog restart causes the session to expire early, Studio will log in again and try again.

Connection Test

Test ResultsExplanation
SuccessStudio has connected to Watchdog and read version and other status information.
FailuresIssues with address, port, network, account password, or Watchdog service status.

Check in order when tests fail:

  1. Can the browser or server access http://<watchdog-address>:<port>?
  2. Can Watchdog Web log in with the same account and password?
  3. Whether the firewall allows Watchdog ports.
  4. Whether the Watchdog service is activated.
  5. If accessed through the tunnel, confirm that both Studio Broker and Watchdog Client have been successfully bound.

Backup Management

Click "Backup" in the Watchdog card or list operation to open the backup drawer.

Watchdog Backup Drawer

Columns or OperationInstructions
NameName of the backup file on the target Watchdog.
Creation timeBack up creation time.
SizeBackup Size.
Restorerestore the backup to the target Watchdog current project.
DeleteDelete the backup on the target Watchdog.
Recovery Impact

Performing backup recovery from Studio produces the same effect as recovery in Watchdog Web, both changing the target gateway project content. Before resuming, please confirm that the target project has a rollback version.

Linking with Project Upload

When uploading a project on the "My Projects" page, the target gateway list comes from the Watchdog service saved on this page.

Upload the project to the gateway drawer

Upload fieldsRelationship with Watchdog
Target gatewayService configuration saved from the Watchdog page.
Publishing Method"Normal Release" or "AOT Release," affecting the content of the uploaded package and the target runtime requirements.
Target environmentneeds to match the system and architecture where the target Watchdog operates.
Update RUNTIMEwill update the target GatewayRuntime program file.
Forced restoration of NuGetRestoring dependencies upon release; Depend on exceptions or switch target environments before use.

Pre-release recommendations:

  1. On the "Watchdog" page, click "Test" to confirm Watchdog is online.
  2. Open the backup drawer or Watchdog Web to create a backup for the target project.
  3. After uploading, check the results on the dashboard and logs of Watchdog Web.

Integration with Project Download

When clicking "Download from Gateway" on the "My Project" page, the source gateway also comes from the Watchdog service saved on this page.

Download project drawer from gateway

Download fieldDescription
After the source gatewayselects the Watchdog service, Studio reads the list of items on that Watchdog.
Project ListSelect the project you want to download back to Studio.
Override existing projectsWhether to overwrite if there is a project with the same name locally.

Downloading is suitable for field configuration retrieval, fault reproduction, and version comparison. After downloading, verify the project configuration and confirm that the project name did not overwrite the wrong local project.

Division of Labor with Watchdog Web

TasksRecommended Entry
Saving Multiple Watchdog ConnectionsStudio Web > Watchdog
Upload Studio ProjectsStudio Web > My Projects
Download Live Projects to StudioStudio Web > My Projects
Observe Target Run LogsWatchdog Web > Logs View
Create Current Project BackupWatchdog Web > Backup Management or Studio Watch Dog Backup Drawer
Modify Watchdog Running ParametersWatchdog Web > Settings
Configure Watchdog Tunnel ClientWatchdog Web > Tunnel Management

Frequently Asked Questions

PhenomenaHandling Suggestions
Test failure after adding a serviceCheck whether the service address is falsely labeled as port, whether the port is filled correctly, and whether the username and password are correct.
HTTP IP addresses cannot be saved or accessedcurrent version allows HTTP IPs. Check whether Watchdog is listening to 0.0.0.0:6200 and enable remote management, standard HTTP permissions, and firewall ports.
Connection test returns 401Check Watchdog account and password; After Watchdog reboots, Studio logs in again, and a persistent 401 usually means credentials are invalid.
Connection test returns 403Check Watchdog RemoteManagementEnabled; Upload, recovery, and process control also require RemoteDeploymentEnabled.
Watchdog is online but the gateway stopsopen the Watchdog web dashboard to view the last errors and logs.
Backup drawer is emptyThe target Watchdog has no backup, or the backup list failed to read; You can check again on Watchdog Web.
Upload the project goal list to emptyAdd the service first on the "Watchdog" page and save it.
Gateway abnormality after restoring backupCheck Watchdog logs, and restore to the previous backup or re-upload the project if necessary.