Endpoint to see the status of the API is up & running

[corey_r]

Hi Wavefront team,

We are using a lot your API (which is very nice).

But as every system it could fail. So do you have an endpoint to see if it's alive ? Something like a /status that answers 200 is ok, 500 is ko?

Thanks!

[corey_r · Accepted solution]

Hi Rémy-Christophe,

That's a great question! We don't have a designated "alive" endpoint, as, strictly speaking, the API should have the same availability as the service itself, and we're monitoring its performance closely. Having said that, the closest thing to the "alive" endpoint would be running a simple query (that won't introduce a lot of additional load) over a short period of time (10 minutes or less).

Here's a good example of such query that would work for all customers:

limit(1, ts(~agent.points.*.sent))

If the API is working, the query returns HTTP 200 and a few data points.

[corey_r]

Thanks, as always, for the quick answer.