📗
Janus Manual
  • Introduction
  • Installation
    • Docker
  • Quick Start
    • Authenticating
    • Add an endpoint
    • Modify (Update/Delete) an endpoint
    • Add Plugins
    • Authentication
    • Adding your API - File System
  • Clustering/HA
  • Proxy Reference
    • Terminology
    • Overview
    • Routing capabilities
    • Load Balacing
    • Request Host header
      • Using wildcard hostnames
      • The preserve_host property
    • Request URI
      • The strip_path property
      • The append_path property
    • Request HTTP method
    • Routing priorities
    • Conclusion
  • Plugins
    • Basic
    • Organization
    • Body Limit
    • Circuit Breaker
    • Compression
    • CORS
    • OAuth
    • Rate Limit
    • Request Transformer
    • Response Transformer
    • Retry
  • Auth
    • OAuth 2.0
  • Misc
    • Health Checks
    • Monitoring
    • Tracing
  • Known Issues
    • Stale HTTP Keep-Alive
  • Upgrade Notes
    • 2.x to 3.x
    • 3.6.x to 3.7.x
Powered by GitBook
On this page

Was this helpful?

  1. Misc

Health Checks

Health checks can be added to each API definition by simply setting these properties:

url: The url to be checked timeout: A timeout in seconds for the health check. If the timeout is reached an error is returned.

You will be able to see all your health checks on the admin REST endpoint /status. If everything is ok you will see something like this:

{
    "status": "OK",
    "timestamp": "2017-06-21T13:06:50.546685883+02:00"
}

If you have any problems you'll see something like this:

{
    "status": "Partially Available",
    "timestamp": "2017-06-21T14:44:38.782346389+02:00",
    "failures": {
        "example": "example is not available at the moment"
    }
}

Each one of the services must provide an endpoint that Janus can use to check how is the service performing. The response code that the endpoint returns will define if the service is healthy, partially healthy or unhealthy

Code

Description

200 - 399

Service fully working

400 - 499

Service partially working

500 >

Service not working

PreviousMiscNextMonitoring

Last updated 4 years ago

Was this helpful?