Aggregate health

GET 
/health

Returns the overall health of the server and the result of each check, with status 200 when the HTTP server and the entity store are up and 503 otherwise. The endpoint needs no authentication and is also served at /health and /health.html outside the /api base path, for probes that require well-known root paths.

Responses

200

The entity store is up. The body reports up, with the result of each component check.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Response code, 0 for success

status stringrequired

Possible values: [up, down]

Aggregate health status

checks

object[]

required

Per-component check results

Array [

name stringrequired

Name of the component being checked

status stringrequired

Possible values: [up, down]

Status of the component

details

object

Optional diagnostic details about the check result

property name* string

]

Example (from schema)

{
  "code": 0,
  "status": "up",
  "checks": [
    {
      "name": "entityStore",
      "status": "up",
      "details": {}
    }
  ]
}

AggregateHealthUp

All checks up

{
  "code": 0,
  "status": "up",
  "checks": [
    {
      "name": "httpServer",
      "status": "up",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "up",
      "details": {}
    },
    {
      "name": "search",
      "status": "up",
      "details": {}
    }
  ]
}

503

The entity store is down, or the server has run out of memory. The body reports down, with the result of each component check; optional components such as search are reported but do not change the aggregate status.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Response code, 0 for success

status stringrequired

Possible values: [up, down]

Aggregate health status

checks

object[]

required

Per-component check results

Array [

name stringrequired

Name of the component being checked

status stringrequired

Possible values: [up, down]

Status of the component

details

object

Optional diagnostic details about the check result

property name* string

]

Example (from schema)

{
  "code": 0,
  "status": "up",
  "checks": [
    {
      "name": "entityStore",
      "status": "up",
      "details": {}
    }
  ]
}

AggregateHealthDown

Entity store probe timed out

{
  "code": 0,
  "status": "down",
  "checks": [
    {
      "name": "httpServer",
      "status": "up",
      "details": {}
    },
    {
      "name": "entityStore",
      "status": "down",
      "details": {
        "reason": "timeout"
      }
    },
    {
      "name": "search",
      "status": "up",
      "details": {}
    }
  ]
}

OutOfMemory

Out of memory, restart required

{
  "code": 0,
  "status": "down",
  "checks": [
    {
      "name": "jvm",
      "status": "down",
      "details": {
        "reason": "OutOfMemoryError; restart required"
      }
    }
  ]
}

4XX

The request is malformed or fails validation, for example because of invalid JSON, a missing required field or an invalid parameter value. The body is normally an error model, although the server's middleware can return plain text instead.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1003,
  "type": "BadRequestException",
  "message": "Malformed request"
}

5XX

The server hit an internal error that the client usually cannot fix by changing the request.

application/vnd.gravitino.v1+json

Schema

Schema

code integerrequired

Possible values: >= 1000 and <= 1100

HTTP response code

type stringrequired

Internal type definition of the error

message stringrequired

A human-readable message

stack string[]deprecated

Deprecated diagnostic stack trace. Enterprise omits it by default because it can expose internal implementation details. Operators can opt in for controlled diagnostics with gravitino.server.webserver.includeErrorStackTrace=true. See OWASP REST Security: Error handling and CWE-209.

Example (from schema)

{
  "code": 1002,
  "type": "string",
  "message": "string"
}

Example

{
  "code": 1002,
  "type": "RuntimeException",
  "message": "Internal Server Error",
  "stack": [
    "java.lang.RuntimeException: Internal Server Error"
  ]
}

Loading...