Skip to main content

Health Endpoint Overview

Status:​

Provides a summary of the overall state of the application.

Version:​

Displays the current version of Link.

Results​

Connectivity Service:​

  • Healthy: When the Connectivity Service is bound or not required given the configuration.

  • Degraded: When the Connectivity Service is not bound or inaccessible.

XSUAA Authentication Service:​

  • Healthy: When the XSUAA Authentication Service is bound or not required given the configuration.

  • Degraded: When the XSUAA Authentication Service is not bound or inaccessible while set up for principle propagation authentication.

Destination Service:​

  • Healthy: When the Destination Service is bound or when not required given the configuration.

  • Degraded: When the Destination Service is not bound or inaccessible while utilizing BTP destinations to bind to SAP environments.

Configuration Validation:​

  • Healthy: When valid configuration is provided.

  • Degraded: When invalid configuration is detected, listing the validation errors.

OAS File Service:​

  • Healthy: When all configured OAS files are reachable and pass validation, listing each configured file and its validation state and reachability.

  • Degraded: When one or more files are not reachable or not parsable as valid OAS file.

Metrics​

Provides current usage data, including:

  • Current Requests per Second
  • Total Requests since the app started
  • Current requests being processed
  • Current count of failed requests
  • Last restart time of the app

Example​

{
  "Status": "Healthy",
  "Version": "5.1.0.0",
  "Results": {
    "Connectivity Service": {
      "Status": "Healthy",
      "Description": null,
      "Details": {}
    },
    "XSUAA Authentication Service": {
      "Status": "Healthy",
      "Description": null,
      "Details": {}
    },
    "Destination Service": {
      "Status": "Healthy",
      "Description": "Destinations loaded successfully",
      "Details": {
        "Source: sap_dev": "Destination loaded successfully",
      }
    },
    "OAS File Service": {
      "Status": "Healthy",
      "Description": "1 OAS sources loaded successfully",
      "Details": {
        "enosix_oas_file": {
          "LoadedOn": "2024-07-18T19:24:46.0801043+00:00",
          "StatusMessage": "OAS file loaded successfully",
          "Title": "enosix schema document"
        }
      }
    },
    "Configuration Validation": {
      "Status": "Healthy",
      "Description": null,
      "Details": {}
    }
  },
  "Metrics": {
    "status": "Healthy",
    "description": "",
    "data": {
      "start-time": "07/18/2024 19:24:50",
      "requests-per-second": "0",
      "total-requests": "1",
      "current-requests": "0",
      "failed-requests": "0"
    }
  }
}