Liveness check

GET 
/health/live

Returns status 200 while the server can answer HTTP requests and 503 after it has run out of memory, for use as a Kubernetes liveness probe. The endpoint needs no authentication and is also served at /health/live outside the /api base path.

Responses

200

The server can answer HTTP requests. The body reports up.

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": {}
    }
  ]
}

LivenessUp

HTTP server up

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

503

The server has recorded an out-of-memory error and needs a restart. Every health endpoint returns this response from then on.

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": {}
    }
  ]
}

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...