Template function to expose Checks for a Consul Service

[CpuID]

Is there currently a clean way to expose the list of Checks for a service? Example, the result of an API call to /v1/health/checks/someservicename. Specifically wanting to extract the URI being hit for HTTP based status checks, most likely will have to extract from the Output property (not the cleanest, but otherwise would need to expand the Consul API upstream).

If not, I am happy to PR something to support it.

[sethvargo]

Hi @CpuID

There is not currently a way to list checks for a service, and it has not been a widely requested feature. If that endpoint supports blocking queries in Consul, you can add a new dependency type, template function, docs, and associated tests (it's rather easy and captured with the other items in the dependency package). I would definitely review a PR for this.

[CpuID]

Thanks for the feedback @sethvargo :)

https://www.consul.io/docs/agent/http/health.html#health_checks - This endpoint supports blocking queries and all consistency modes.

I'll make an attempt at a PR and send it your way.

[sethvargo]

Hey @CpuID

Did you still want to try to submit a PR for this?

[CpuID]

Hey @sethvargo - definitely wanting to, have struggled to find the time so far (I am getting back into the project that depends on this nowish though). I might try do it on my flight over to Amsterdam next weekend worst case (before HashiConf EU).

[CpuID]

Pending results of hashicorp/consul#1680 and a PR to expose the check components in the Consul API, currently the closest thing to it is the Output key which looks something like HTTP GET http://1.2.3.4:80/health: 200 OK Output: \"healthy\". Would prefer to not have to parse this out on the consul-template side.

[CpuID]

@sethvargo as this is still pending a response on hashicorp/consul#1680 - did you want to hassle @slackpad for some movement ? :)

[CpuID]

Worth noting (for PR followers): @sethvargo and @slackpad are both no longer at Hashicorp, so we will likely need to consider community derived PRs to get this over the line :) If I get time I'll try to get something done soonish.