Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Q&A

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Post History

75%
+4 −0
Q&A What should healthcheck of an Web API application actually check?

I am interested in a guideline to understand how dependencies are considered when building the healthcheck functionality for an API. Like any functionality, the implementation of this feature sho...

posted 3y ago by meriton‭  ·  edited 3y ago by meriton‭

Answer
#2: Post edited by user avatar meriton‭ · 2021-03-08T19:39:38Z (over 3 years ago)
  • > I am interested in a guideline to understand how dependencies are considered when building the healthcheck functionality for an API.
  • Like any functionality, the implementation of this feature should be guided by specific requirements. Who will be using that feature? What for?
  • For instance, if this healthcheck is an enpoint for a kubernetes liveness probe (which causes an automatic restart of the pod if it deems itself unhealthy), including external systems doesn't make sense, because restarting your app won't fix these systems.
  • On the other hand, if the health check is used by an actual human, they might be able to interpret a more nuanced response, and prefer being informed when optional dependencies fail.
  • > I am interested in a guideline to understand how dependencies are considered when building the healthcheck functionality for an API.
  • Like any functionality, the implementation of this feature should be guided by specific requirements. Who will be using that feature? What for?
  • For instance, if this healthcheck is an endpoint for a kubernetes liveness probe (which causes an automatic restart of the pod if it deems itself unhealthy), including external systems doesn't make sense, because restarting your app won't fix these systems.
  • On the other hand, if the health check is used by an actual human, they might be able to interpret a more nuanced response, and prefer being informed when optional dependencies fail.
#1: Initial revision by user avatar meriton‭ · 2021-03-08T19:39:17Z (over 3 years ago)
> I am interested in a guideline to understand how dependencies are considered when building the healthcheck functionality for an API.

Like any functionality, the implementation of this feature should be guided by specific requirements. Who will be using that feature? What for? 

For instance, if this healthcheck is an enpoint for a kubernetes liveness probe (which causes an automatic restart of the pod if it deems itself unhealthy), including external systems doesn't make sense, because restarting your app won't fix these systems. 

On the other hand, if the health check is used by an actual human, they might be able to interpret a more nuanced response, and prefer being informed when optional dependencies fail.