Lexicon Garden

at.happyproto.server.getLogs

A page of what one of the caller's own instances wrote, redacted on its host. Customers only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityserver.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

cursor

string

The cursor a previous page returned, with the same direction.

deploymentId

string

Bound the page to this deployment's window, read from the host it ran on.

direction

string

backward: the newest lines before until or cursor. forward: the oldest after since or cursor.

  • default: "backward"
  • knownValues: backward | forward

id

requiredstring

The instance's UUID.

limit

integer
  • minimum: 1
  • maximum: 1000
  • default: 200

since

string · datetime

Narrows the window; never widens a deployment's.

until

string · datetime

Narrows the window; never widens a deployment's.

Output

application/json

cursor

string

Pass with the same direction for the next page. Absent when there are no lines.

lines

requiredarray

Oldest first, whichever way the page was read.

itemsref
Reference

more

requiredboolean

Whether more lines lie beyond this page in its direction.

oldestAvailable

string · datetime

The oldest line the host still holds, on a page read without a cursor.

window

ref
Reference

Errors

InvalidRequest

An id is not a UUID, or a time, cursor, direction or limit is malformed or out of range.

NotFound

No such instance or deployment, or either is not the caller's. These are indistinguishable.

NotADeployment

The change started no container (a stop, a deletion or a domain-only update), so it has no logs of its own.

LogsUnavailable

The host the logs are on is not answering, or no longer holds the instance.

LogsBusy

Too many log reads are running for this instance or its host. Try again shortly.

LogsTimeout

Reading the logs took too long. Narrow the time range.

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not a HappyProto customer, or the provisioner refused them.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

#line

object

Properties

at

requiredstring · datetime

level

string

When the line says.

  • knownValues: trace | debug | info | warn | error

message

requiredstring

With the instance's secrets and anything shaped like a credential replaced by [redacted].

stream

requiredstring
  • knownValues: stdout | stderr

#window

object

The deployment's window, when deploymentId was given.

Properties

since

requiredstring · datetime

until

string · datetime

Absent while the deployment is the newest.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • dev.knotless.getLogs

    query

    The lines an appview logged, for its operators, oldest first: all of one request's by its trace, or the last of a message, a level or a duration. It takes a service token for this method from one of the accounts it names as its operators, or the session cookie of one logged in to its pages. Kept across restarts, at most 30 days. Each read is itself logged, with who asked.

  • at.happyproto.server.listDeployments

    query

    The changes made to one of the caller's own instances, newest first, a page at a time. Customers only.