System Healthchecks

Owned by Vincent Josset
Feb 23, 2023
2 min read

Health checks are automated endpoints to check that your Softrip applications are running correctly.

These health checks are typically used for overall system monitoring, but can also be used in a load-balanced setup to ensure that each instance in a load-balanced group is ready to receive and process requests.

When implementing these healthchecks, Softrip recommends treating the "Healthy" status as success and all other results as failure. For example, if the application is not running, the healthcheck will not return "Unhealthy" but rather a failed HTTP status (503, 500, 404, etc.).

All healthchecks detailed below require Softrip version 2022.14 or later.

If an instance is healthy, its response should return in less than 1 second.

 

SoftripNext

STServerWeb

  • Basic health check:

    • https://stsw.domain.com/healthcheck.txt

    • Returns the string "Healthy" if instance is healthy

    • All other results should be treated as unhealthy

  • Detailed health check:

    • https://stsw.domain.com/healthcheck.json

    • Returns a JSON string indicating the status of each component of STServerWeb

 

ResWebNext

  • Basic health check:

    • https://www.domain.com/rwn/healthcheck.txt

    • Returns the string "Healthy" if instance is healthy

    • All other results should be treated as unhealthy

  • Detailed health check:

    • https://www.domain.com/rwn/healthcheck.json

    • Returns a JSON string indicating the status of each component of ResWebNext

SoftripNet

STServerService

  • Basic health check:

    • http://mt.domain.com:8000/CALL/?Req=<Request TransType="HEALTH.BASIC"></Request>

    • Returns the string "Healthy" if instance is healthy

    • All other results should be treated as unhealthy

  • Detailed health check:

    • http://mt.domain.com:8000/CALL/?Req=<Request TransType="HEALTH.FULL"></Request>

    • Returns a JSON string indicating the status of each component of STServerService

 

Note that when implementing this healthcheck in PRTG, you will need to set the sensor up with a POST request (passing in the request as the POST data instead of the query string) rather than a GET request.

STRes

  • Basic health check:

    • https://www.domain.com/res/json.aspx?TransType=HEALTH.BASIC

    • Returns the string "Healthy" if instance is healthy

    • All other results should be treated as unhealthy

  • Detailed health check:

    • https://www.domain.com/res/json.aspx?TransType=HEALTH.FULL

    • Returns a JSON string indicating the status of each component of STRes

 

Note that when implementing this healthcheck in PRTG, you will need to set the sensor up with a POST request (passing in "TransType=HEALTH.BASIC" as the POST data instead of the query string) rather than a GET request.

RServer

  • Basic health check:

    • https://rerver.domain.com/?xmlrequest=<Request TransType="air.PING"><BID>[YOURBID]</BID></Request>

    • Returns an XML string that includes the string "PONG" if healthy

    • All other results should be treated as unhealthy

 

Note that when implementing this healthcheck in PRTG, you will need to set the sensor up with a POST request (passing in the request as the POST data instead of the query string) rather than a GET request.