lexicons and xrpc
lexicon
com.fedfork.exec.ops.getHealth
A bidder answers its core's health since its process started: its unit, start time, ERROR line counts (all, and in its first 10 minutes), automatic restarts, VM processes, the last three ERROR lines and its guest image readiness. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.
definitions: #errorLine
output
| field | type | description |
|---|---|---|
unit * | string | |
started * | string datetime | |
errors * | integer | |
startupErrors * | integer | |
restarts * | integer | |
vmProcesses * | integer | |
errorSample * | array of #errorLine | maxLength 3 |
guestImageReadyAt * | string | |
guestImageUnready * | integer |
errors
| error | description |
|---|---|
AuthenticationRequired | 401: the ops read secret is missing or wrong. |
ReadFailed | 502: the read failed; the host's log has the detail. |
#errorLine object
| field | type | description |
|---|---|---|
time * | string | |
msg * | string | |
err * | string | maxLength 160 |
used in
no page of these docs names it yet.
raw schema: lexicons/com/fedfork/exec/ops/getHealth.json
{
"lexicon": 1,
"id": "com.fedfork.exec.ops.getHealth",
"defs": {
"main": {
"type": "query",
"description": "A bidder answers its core's health since its process started: its unit, start time, ERROR line counts (all, and in its first 10 minutes), automatic restarts, VM processes, the last three ERROR lines and its guest image readiness. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.",
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"unit",
"started",
"errors",
"startupErrors",
"restarts",
"vmProcesses",
"errorSample",
"guestImageReadyAt",
"guestImageUnready"
],
"properties": {
"unit": {
"type": "string"
},
"started": {
"type": "string",
"format": "datetime"
},
"errors": {
"type": "integer"
},
"startupErrors": {
"type": "integer"
},
"restarts": {
"type": "integer"
},
"vmProcesses": {
"type": "integer"
},
"errorSample": {
"type": "array",
"maxLength": 3,
"items": {
"type": "ref",
"ref": "#errorLine"
}
},
"guestImageReadyAt": {
"type": "string"
},
"guestImageUnready": {
"type": "integer"
}
}
}
},
"errors": [
{
"name": "AuthenticationRequired",
"description": "401: the ops read secret is missing or wrong."
},
{
"name": "ReadFailed",
"description": "502: the read failed; the host's log has the detail."
}
]
},
"errorLine": {
"type": "object",
"required": [
"time",
"msg",
"err"
],
"properties": {
"time": {
"type": "string"
},
"msg": {
"type": "string"
},
"err": {
"type": "string",
"maxLength": 160
}
}
}
}
}