Health endpoint

[gmelodie]

We should have a /version endpoint that returns the version an Estuary node and shuttle are running:

curl api.estuary.tech/health
{
    version: "version-here",
    ...
}

Also, have this data injested into Grafana

[en0ma]

@gmelodie you meant /health right? Also, I am not sure adding this endpoint is necessary as it already exists for both primary at https://github.com/application-research/estuary/blob/master/handlers.go#L124 and shuttle at https://github.com/application-research/estuary/blob/master/cmd/estuary-shuttle/main.go#L975.

The only thing I cant say is what monitoring tool is currently being used to check these endpoints for uptime.

[gmelodie]

@en0ma we should document both the version and the health endpoints

[en0ma]

@en0ma we should document both the version and the health endpoints

@gmelodie how do you mean document them? Also, I think the question we should be asking is how is the /health endpoint currently being used (or if not, how do we start using it)

[gmelodie]

I mean we should have those endpoints on https://docs.estuary.tech

[en0ma]

I do not think so, /health is for internal monitoring. If we want to allow users to know about API status - we need a status page for that, and its more than just a health endpoint

[gmelodie]

Still, the docs should exist for the team. Not sure where these would go though

[corinne-antonia]

I'll have @jimmylee added to the docs on estuary.tech and we can close this issue

[gmelodie]

Also maybe we could add this to the Troubleshooting section on the wiki once it's done