Add default healthcheck port in the documentation

[ledor473]

No description provided.

[yurishkuro]

@black-adder could you verify for accuracy?

[yurishkuro]

isn't healthcheck at /health endpoint?

[yurishkuro]

is there an issue / other PR this one can be linked to, for references / background?

[ledor473]

I was about to create an issue, but I saw this: #64

Here's various places I found the information about healthcheck:

• https://github.com/kubernetes/charts/blob/master/incubator/jaeger/templates/collector-deploy.yaml#L106-L112
• Inital PR: Added liveness and readiness checks to collector and query jaeger#280
• Refactor 1: Refactor healthcheck pkg, fix race condition in tests jaeger#631
• Refactor 2: Add healthcheck to standalone jaeger#784

[ledor473]

As for the /health or /, I tried to test it against the collector but both the proper path and any random path returns HTTP 204. I think it's a bit confusing, but that could be treated as a different issue:

# curl -v localhost:14269/random
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 14269 (#0)
> GET /random HTTP/1.1
> Host: localhost:14269
> User-Agent: curl/7.52.1
> Accept: */*
> 
< HTTP/1.1 204 No Content
< Date: Wed, 23 May 2018 14:05:29 GMT
< 
* Curl_http_done: called premature == 0
* Connection #0 to host localhost left intact

# curl -v localhost:14269/
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 14269 (#0)
> GET / HTTP/1.1
> Host: localhost:14269
> User-Agent: curl/7.52.1
> Accept: */*
> 
< HTTP/1.1 204 No Content
< Date: Wed, 23 May 2018 14:04:01 GMT
< 
* Curl_http_done: called premature == 0
* Connection #0 to host localhost left intact

# curl -v localhost:14269/health
*   Trying ::1...
* TCP_NODELAY set
* Connected to localhost (::1) port 14269 (#0)
> GET /health HTTP/1.1
> Host: localhost:14269
> User-Agent: curl/7.52.1
> Accept: */*
> 
< HTTP/1.1 204 No Content
< Date: Wed, 23 May 2018 14:04:08 GMT
< 
* Curl_http_done: called premature == 0
* Connection #0 to host localhost left intact

[yurishkuro]

@jpkrohling is this some sort of convention that we're serving health check at / instead of /health?

https://github.com/jaegertracing/jaeger/blob/7796f75dae1441c3a8a53abfaaf9ec3cb45b9705/pkg/healthcheck/handler.go#L121

[jpkrohling]

Not really. The key part, though, is that it's on a dedicated port so that an admin can block this port from being exposed over the public internet. The handler will respond to any request on that port.

[jpkrohling]

By the way: I think we'll (or should) end up consolidating the ports as part of jaegertracing/jaeger#773, so, we might end up with just two ports (private network, public internet).

[yurishkuro]

Thanks, @ledor473