Health_Check_API.md

Health Check API

• Motivation
• Solution
  • Concepts
  • Implementation
• Pros & Cons
  • Pros
  • Cons
• Consideration
• When To Use
• References

Motivation

Solution

Concepts

• A service exposes a health check API endpoint which returns the health of the service.
• A health check client periodically invokes the endpoint to check the health of the service instance.
• A health check client can be
  • Monitoring service
  • Service registry
  • Load balancer

Implementation

• Basic measurements of the application's availability and performance:
  • The response code.
  • The content of response.
  • The response time (network latency + request processing time).

Pros & Cons

Pros

Cons

Consideration

Topic	Consideration	Possible Solution Options
Security	Protect the health check endpoint from public access	Eable authentication for accessing the health check endpoint. Expose the health check endpoint on a different IP address. Configure the health check endpoint on a non-standard HTTP port.

When To Use

References

• Book: Chris R.(2018). Chapter 11 Developing production-ready services, Microservices Patterns (pp. 348-382). Manning Publications
• Web Article: Pattern: Health Check API | https://microservices.io/patterns/observability/health-check-api.html
• Web Article: Health Endpoint Monitoring pattern | https://docs.microsoft.com/en-us/azure/architecture/patterns/health-endpoint-monitoring