To make the API more self-discoverable we should include the URL and type of the service of the service instead of only the socket address (binding) in the health check report.
Current endpoint
URL: http://127.0.0.1:1313/health_check
{
"status": "Ok",
"message": "",
"details": [
{
"binding": "0.0.0.0:6969",
"info": "checking the udp tracker health check at: 0.0.0.0:6969",
"result": {
"Ok": "Connected"
}
},
{
"binding": "0.0.0.0:6868",
"info": "checking the udp tracker health check at: 0.0.0.0:6868",
"result": {
"Ok": "Connected"
}
},
{
"binding": "0.0.0.0:7171",
"info": "checking http tracker health check at: http://0.0.0.0:7171/health_check",
"result": {
"Ok": "200 OK"
}
},
{
"binding": "0.0.0.0:1212",
"info": "checking api health check at: http://0.0.0.0:1212/api/health_check",
"result": {
"Ok": "200 OK"
}
},
{
"binding": "0.0.0.0:7070",
"info": "checking http tracker health check at: http://0.0.0.0:7070/health_check",
"result": {
"Ok": "200 OK"
}
}
]
}New proposal
{
"status": "Ok",
"message": "",
"details": [
{
"type": "udp_tracker",
"url": "udp://0.0.0.0:6969",
"binding": "0.0.0.0:6969",
"info": "checking the udp tracker health check at: 0.0.0.0:6969",
"result": {
"Ok": "Connected"
}
},
{
"type": "udp_tracker",
"url": "udp://0.0.0.0:6868",
"binding": "0.0.0.0:6868",
"info": "checking the udp tracker health check at: 0.0.0.0:6868",
"result": {
"Ok": "Connected"
}
},
{
"type": "http_tracker",
"url": "http://0.0.0.0:7171",
"binding": "0.0.0.0:7171",
"info": "checking http tracker health check at: http://0.0.0.0:7171/health_check",
"result": {
"Ok": "200 OK"
}
},
{
"type": "tracker_rest_api",
"url": "http://0.0.0.0:1212",
"binding": "0.0.0.0:1212",
"info": "checking api health check at: http://0.0.0.0:1212/api/health_check",
"result": {
"Ok": "200 OK"
}
},
{
"type": "http_tracker",
"url": "http://0.0.0.0:7070",
"binding": "0.0.0.0:7070",
"info": "checking http tracker health check at: http://0.0.0.0:7070/health_check",
"result": {
"Ok": "200 OK"
}
}
]
}cc @da2ce7
To make the API more self-discoverable we should include the URL and type of the service of the service instead of only the socket address (
binding) in the health check report.Current endpoint
URL: http://127.0.0.1:1313/health_check
{ "status": "Ok", "message": "", "details": [ { "binding": "0.0.0.0:6969", "info": "checking the udp tracker health check at: 0.0.0.0:6969", "result": { "Ok": "Connected" } }, { "binding": "0.0.0.0:6868", "info": "checking the udp tracker health check at: 0.0.0.0:6868", "result": { "Ok": "Connected" } }, { "binding": "0.0.0.0:7171", "info": "checking http tracker health check at: http://0.0.0.0:7171/health_check", "result": { "Ok": "200 OK" } }, { "binding": "0.0.0.0:1212", "info": "checking api health check at: http://0.0.0.0:1212/api/health_check", "result": { "Ok": "200 OK" } }, { "binding": "0.0.0.0:7070", "info": "checking http tracker health check at: http://0.0.0.0:7070/health_check", "result": { "Ok": "200 OK" } } ] }New proposal
{ "status": "Ok", "message": "", "details": [ { "type": "udp_tracker", "url": "udp://0.0.0.0:6969", "binding": "0.0.0.0:6969", "info": "checking the udp tracker health check at: 0.0.0.0:6969", "result": { "Ok": "Connected" } }, { "type": "udp_tracker", "url": "udp://0.0.0.0:6868", "binding": "0.0.0.0:6868", "info": "checking the udp tracker health check at: 0.0.0.0:6868", "result": { "Ok": "Connected" } }, { "type": "http_tracker", "url": "http://0.0.0.0:7171", "binding": "0.0.0.0:7171", "info": "checking http tracker health check at: http://0.0.0.0:7171/health_check", "result": { "Ok": "200 OK" } }, { "type": "tracker_rest_api", "url": "http://0.0.0.0:1212", "binding": "0.0.0.0:1212", "info": "checking api health check at: http://0.0.0.0:1212/api/health_check", "result": { "Ok": "200 OK" } }, { "type": "http_tracker", "url": "http://0.0.0.0:7070", "binding": "0.0.0.0:7070", "info": "checking http tracker health check at: http://0.0.0.0:7070/health_check", "result": { "Ok": "200 OK" } } ] }cc @da2ce7