Monitoring

The a.sign RK HSM provides an interface for automatic monitoring. This is accessible via the following link: https://<a_sign_RK_HSM_IP>/api/Status.ashx.

Access to the Status.ashx page is secured by username and password. For the authentication the user and password of the administration's website is to be used. (See section Administrators web interface)

The overall status of a.sign RK HSM is expressed via the HTTP status code. An HTTP status code of 200 is a fully functional server. An HTTP status code of 500 corresponds to a server in error condition.

For both HTTP status codes a JSON message is returned with the following format:

{
  "Services": [
    {
      "Name": "ATrustHsmApi",
      "Load": "loaded",
      "Active": "active",
      "Sub": "running",
      "OK": true
    },
    {
      ...
    },
    ...
  ],
  "DiskSpaceEntries": [
    {
      "FileSystem": "/dev/mapper/ubuntu--vg-ubuntu--lv",
      "Size": "137906712",
      "Used": 13,
      "Available": "113889048",
      "UsePercent": "13%",
      "MountedOn": "/"
    },
    {
      ...
    },
    ...
  ],
  "Warnings": [],
  "UpTime": "3 weeks,3 days,23 hours,23 minutes",
  "CpuUsage": 2,
  "MemUsage": 20,
  "OverallStatus": true,
  "TestSignature": true
}

• Line 2: List of HSM Services and there state
• Line 15: List of Mount points with their size and available space
• Line 29: If an error occurs, the error messages are listed here.
• Line 30: Uptime of server
• Line 31: Current CPU usage in percent
• Line 32: Current memory usage in percent
• Line 33: Overall state of server, same as HTTP status code
• Line 34: State of test signature

Calculation of overall state

The overall status is calculated from the various tests.

• Each service must have the state loaded /active /running, otherwise it is considered to be in the error state.
• The free disk space must be more thean 10%.
• The CPU and memory usage must be below 95%.
• The test signature must be successful.
• The server uptime is ignored for the overall calculation.