get-health¶

Description¶

Returns the CLO component (Scheduler, dispatcher, DAO) wise health check result. Service specific result will include the state of the service (healthy or unhealthy) and additional details.

Synopsis¶

  get-health
--datahub-crn <value>
[--scope <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--datahub-crn (string)

The CRN of the CLO Data Hub.

--scope (string)

Health check scope. The supported values are “Full” and “Partial”. The “Full” performs a deep health check along with livy session creation. The “Partial” performs a shallow health check which doesn’t involve session creation.

Possible values:

• Full

• Partial

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

result -> (map)

Map containing the service wise health check result.

key -> (string)

value -> (object)

Health check result.

isHealthy -> (boolean)

Service health status. The supported values are true or false. “true” represents the service is healthy and “false” represents the service is in an unhealthy state.

message -> (string)

Service health check message.

error -> (string)

Exception during health checks.

details -> (map)

Map with additional service specific details.

key -> (string)

value -> (string)

Additional service details encoded as a string (Example: “Tasks”: “[]”, “Dispatched count”: “5”, “Scheduled count”: “2”)

time -> (integer)

Time when the health check was performed. It will be in milliseconds.

duration -> (integer)

Health check duration in millis.

action -> (string)

Action performed. For example, READ or NOOP or CREATE.

Form Factors¶

public