Monitoring Royal Server

Royal Server is a Windows Service and can be monitored in a few ways:

Monitoring the Windows Service status

You can monitor the status of the Windows Service “Royal Server” which basically is royalserver.exe and see if it is running.

Monitoring the HTTPS endpoint

You can monitor the HTTPS endpoint of Royal server at https://<royal-server-ip-or-name>:<port>/status. The expected response is

RoyalServer Status:CHECK_OK

If you want to see/log some standard performance values together with this, you can call :

https://<royal-server-ip-or-name>:<port>/status?includePerfStats=true

The response will be a JSON object that looks like this:

{
  "status":"RoyalServer Status:CHECK_OK",
  "performance":{
    "cpu":0,
    "threads":18.0,
    "memory":16.339844,
    "requestsPerSecond":0,
    "totalRequests":0,
    "upTime":{
      "value":"00:14:49.1346303"
    },
  "privateBytes":17133568
  }
}

Monitoring the Performance Counter

Royal Server is writing a set of Windows Performance Counters that can be used to monitor Royal Server. The following counters all in the counter group “Royal Server” are available:

  • Cpu Usage %
    Cpu usage of royalserver.exe
  • Memory Private Working Set
    Current memory usage of royalserver.exe
  • MG Current IPs blocked
    Management Endpoint number of blocked IPs (if IP Blocker for Management Endpoint is enabled)
  • Requests / sec
    Requests / seconds executed by Management Endpoint
  • Requests Total
    Total requests executed by Management Endpoint
  • SG Connections dropped - Wrong Softwarename
    During opening a Secure Gateway connection it can be blocked if the Softwarename is wrong
  • SG Connections Open
    Currently open Secure Gateway connections
  • SG Current IPs Blocked
    Number of IPs blocked by the Secure Gateway (if IP Blocker for the Secure Gateway is enabled)
  • Threads
    Number of currently used threads by royalserver.exe