Does Ignition have a health endpoint?

Ignition
1

This would be a simple endpoint in front of any auth that responds with a simple ok and 200 status code used for infrastructure monitoring.

Back in 2021, it sounds like no: Web API to monitor Ignition server health?

The suggestion in that post is to use the WebDev module, but we don't use that and it costs $2249.08, i.e. prohibitive for such a simple feature.

More recently, I saw Ignition has a "Ignition + Docker" webinar that mentions this kind of monitoring, but can't find anything in the docs on this.

I also did some digging because Ignition's docker image has a healthcheck configured, but it's not hitting an endpoint, just running a linux utility: Docker

2

Maybe http://localhost:8088/StatusPing will work? Not exactly a health check but it's probably usable to tell you if the gateway is online or not. Replace "localhost" with your hostname.

5 Likes
3

Try http://my.server.name/StatusPing. Response is JSON.

{ Or http://my.server.name:8088/StatusPing if you don't use the standard port. }

2 Likes
4

Perfect, thanks Kevin.Herron & pturmel! Is there documentation on this kind of thing anywhere?

5

For anyone looking for this in the future, the following works well:

    healthcheck:
      test: /usr/bin/curl -sS http://localhost:8088/StatusPing | grep -c RUNNING > /dev/null
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s
3 Likes