Skip to content

SF-002 Healthcheck

Namespace: synergy/health Last updated: 22.8.2017

Introduction

Application health info provides details about the application’s availability and state for the system administrators.

Usage

Interested parties (e.g. Chemaxon Synergy) will request application health information by sending HTTP GET request to configured URL.

**Example **

HTTP GET http://localhost:8102/services/health

Response

1
2
3
4
{
     status: "UP",
     description: "Service is running."
}

  • status - REQUIRED - application status:

    • "UP": This should be returned by the service if the application is running and providing health endpoint.
    • "SHUTTING_DOWN": This should be returned by the service if the application is running, a providing health endpoint but marked to shut down.
    • "ERROR": This should be returned by the service if the application is running, providing health endpoint but emitting error status.
  • description - **OPTIONAL ** - application status description

Configuration

Application info uses synergy/health namespace and single url attribute.
Example

1
2
3
4
5
6
{
    namespace: "synergy/health", 
    attributes: {
        url: "http://localhost:8102/services/health"
    }
}