Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
Health Check Response Format for HTTP APIs
{
"serviceID": "service:authz",
"description": "health of authz service",
"status": "pass",
"version" : "1",
"release_id" : "1.2.2",
"memory": [4096, 1024, 3456],
"cpu": [20, 40, 50],
"uptime": "1209600.245",
"connections" : 25,
"notes": [""],
"output": "",
"details": [
{
"id": "dfd6cf2b-1b6e-4412-a0b8-f6f7797a60d2",
"name": "sub-component-X",
"value": "12313",
"status": "pass",
"output": ""
},
{
"id": "3c1f048c-a4be-4aa2-83e6-2629073d19dc",
"name": "Cassandra test query duration in ms",
"value": "250",
"status": "warn",
"output": "Response time over target of less than 100ms"
}
],
"links": [
{"rel": "about", "uri": "http://api.example.com/about/authz"},
{
"rel": "http://api.example.com/rel/thresholds",
"uri": "http://api.example.com/about/authz/thresholds"
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment