Trickster provides a /trickster/ping endpoint that returns a response of 200 OK and the word pong if Trickster is up and running. The /trickster/ping endpoint does not check any proxy configurations or upstream origins. The path to the Ping endpoint is configurable, see the configuration documentation for more information.
Trickster offers health endpoints for monitoring the health of the Trickster service with respect to its upstream connection to origin servers.
Each configured origin's health check path is /trickster/health/ORIGIN_NAME. For example, if your origin is named foo, you can perform a health check of the upstream URL at http://<trickster_address:port>/trickster/health/foo.
The origin health path prefix /trickster/health/ is customizable. See the example.conf for more info.
The behavior of a health request will vary based on the Origin Type, as each Origin Type implements a custom default health check behavior. For example, with Prometheus, Trickster makes a request to /query?query=up and (hopefully) receives a 200 OK, while for InfluxDB the request is to /ping which returns a 204 No Content. You can customize the behavior in the Trickster configuration. See the example.conf for guidance.
The Origin-Specific default health check configurations should return a 200-range status code to indicate that the end-to-end health check to the origin was successful. Note that this behavior is not guaranteed when operating under user-provided health check configurations.
The HTTP Reverse Proxy Cache origin type does not have a built-in health check, since those parameters can vary from origin to origin; it must be configured by the operator.
In addition to the out-of-the-box health checks to determine up-or-down status, you may want to setup alarms and thresholds based on the metrics instrumented by Trickster. See metrics.md for collecting performance metrics about Trickster.