Get a page of log lines

GET

/api/tasks/{taskName}/runs/{runId}/log

const url = 'http://localhost:9477/api/tasks/example/runs/example/log?from=-1000';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'http://localhost:9477/api/tasks/example/runs/example/log?from=-1000'

Returns a JSON page of absolute-line-numbered log entries. Use from (negative for tail) and limit to window the result.

Parameters

Path Parameters

taskName

required

Task name

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9._:-]+$/

Task name

runId

required

Run ULID

string

>= 26 characters <= 26 characters /^[0-9A-HJKMNP-TV-Z]{26}$/

Run ULID

Query Parameters

from

Anchor line number; 0 is the first line, negative values count from end (default -1000)

integer format: int64

default: -1000

Anchor line number; 0 is the first line, negative values count from end (default -1000)

limit

Max lines returned (default 1000)

integer format: int64

>= 1 <= 10000

Max lines returned (default 1000)

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

finalized

required

True if the run has ended and the log is final

boolean

firstAvailable

required

Lowest line number still on disk; lines below were rotated away

integer format: int64

lines

required

Returned lines, ascending by n

Array<object> | null

object

continued

True if this segment continues an oversized split line

boolean

frameCount

Number of recorded prior frames if this line is a settled progress bar / redraw anchor; 0 otherwise

integer format: int64

required

Absolute line number

integer format: int64

stream

required

Stream identifier (stdout/stderr/system)

string

text

required

Line content without trailing newline

string

required

Unix milliseconds timestamp; 0 if unavailable

integer format: int64

totalLines

required

Total lines produced across all segments

integer format: int64

truncated

required

True if rotation has dropped lines below first_available

boolean

Example

{
  "$schema": "http://localhost:9477/schemas/LogPageBody.json"
}

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object> | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}