lexicons and xrpc
lexicon
com.fedfork.exec.ops.getLog
A bidder answers how many lines of its core's log since its process started hold one known message, optionally with one subject, and the first 50 of them as fixed fields. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.
definitions: #line
parameters
| parameter | type | description |
|---|---|---|
msg * | string | One of the known message names. enum ["core_holds_instance","adopted_role","placed","stopped","work_dir_removed","shutdown","vmm_exit","bidder_vm_terminated","released_bid_terminated","hostprocess_unit_adopted","early_kill","bidder_accept_abandoned","bidder_accept_unresolved","accept_provision_failed"] |
subject | string | A ComputeVM name or an at:// URI the line must also hold. |
output
| field | type | description |
|---|---|---|
log * | string | knownValues ["journal","file"] |
count * | integer | |
lines * | array of #line | maxLength 50 |
errors
| error | description |
|---|---|
AuthenticationRequired | 401: the ops read secret is missing or wrong. |
InvalidRequest | 400: msg is not one of the known message names, or subject is neither a ComputeVM name nor an at:// URI. |
ReadFailed | 502: the read failed; the host's log has the detail. |
#line object
time, msg and those of the fixed keys the line has: accept, kind, tries, age, reservationReleased, err, hostprocess, unit, pid, invocation, activeSince, state.
| field | type | description |
|---|---|---|
time | string | |
msg | string | |
accept | unknown | |
kind | unknown | |
tries | unknown | |
age | unknown | |
reservationReleased | unknown | |
err | unknown | |
hostprocess | unknown | |
unit | unknown | |
pid | unknown | |
invocation | unknown | |
activeSince | unknown | |
state | unknown |
used in
no page of these docs names it yet.
raw schema: lexicons/com/fedfork/exec/ops/getLog.json
{
"lexicon": 1,
"id": "com.fedfork.exec.ops.getLog",
"defs": {
"main": {
"type": "query",
"description": "A bidder answers how many lines of its core's log since its process started hold one known message, optionally with one subject, and the first 50 of them as fixed fields. Read only (GET). Served only when the host has an ops read secret configured (else 404); requires it as Authorization: Bearer.",
"parameters": {
"type": "params",
"required": [
"msg"
],
"properties": {
"msg": {
"type": "string",
"enum": [
"core_holds_instance",
"adopted_role",
"placed",
"stopped",
"work_dir_removed",
"shutdown",
"vmm_exit",
"bidder_vm_terminated",
"released_bid_terminated",
"hostprocess_unit_adopted",
"early_kill",
"bidder_accept_abandoned",
"bidder_accept_unresolved",
"accept_provision_failed"
],
"description": "One of the known message names."
},
"subject": {
"type": "string",
"description": "A ComputeVM name or an at:// URI the line must also hold."
}
}
},
"output": {
"encoding": "application/json",
"schema": {
"type": "object",
"required": [
"log",
"count",
"lines"
],
"properties": {
"log": {
"type": "string",
"knownValues": [
"journal",
"file"
]
},
"count": {
"type": "integer"
},
"lines": {
"type": "array",
"maxLength": 50,
"items": {
"type": "ref",
"ref": "#line"
}
}
}
}
},
"errors": [
{
"name": "AuthenticationRequired",
"description": "401: the ops read secret is missing or wrong."
},
{
"name": "InvalidRequest",
"description": "400: msg is not one of the known message names, or subject is neither a ComputeVM name nor an at:// URI."
},
{
"name": "ReadFailed",
"description": "502: the read failed; the host's log has the detail."
}
]
},
"line": {
"type": "object",
"description": "time, msg and those of the fixed keys the line has: accept, kind, tries, age, reservationReleased, err, hostprocess, unit, pid, invocation, activeSince, state.",
"properties": {
"time": {
"type": "string"
},
"msg": {
"type": "string"
},
"accept": {
"type": "unknown"
},
"kind": {
"type": "unknown"
},
"tries": {
"type": "unknown"
},
"age": {
"type": "unknown"
},
"reservationReleased": {
"type": "unknown"
},
"err": {
"type": "unknown"
},
"hostprocess": {
"type": "unknown"
},
"unit": {
"type": "unknown"
},
"pid": {
"type": "unknown"
},
"invocation": {
"type": "unknown"
},
"activeSince": {
"type": "unknown"
},
"state": {
"type": "unknown"
}
}
}
}
}