Search log lines across runs of a task

GET

/api/tasks/{taskName}/log/search

const url = 'http://localhost:9477/api/tasks/example/log/search';
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/log/search

Streams on disk through the task’s runs newest-first and returns matching lines. Pure on-demand scan; no index is maintained. Use cursor to paginate beyond the per-request hit/run budget.

Parameters

Path Parameters

taskName

required

Task name

string

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

Task name

Query Parameters

run_id

Restrict the search to one run (ULID). Empty searches every non-deleted run of the task.

string

Restrict the search to one run (ULID). Empty searches every non-deleted run of the task.

Substring (or regex when regex=true) to search for

string

>= 1 characters <= 1024 characters

Substring (or regex when regex=true) to search for

regex

Treat q as an RE2 regular expression

boolean

Treat q as an RE2 regular expression

case

Match case-sensitively (default is case-insensitive)

boolean

Match case-sensitively (default is case-insensitive)

limit

Max hits returned (default 200)

integer format: int64

>= 1 <= 1000

Max hits returned (default 200)

cursor

Opaque continuation token returned by a previous call

string

Opaque continuation token returned by a previous call

Responses

200

application/json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

exhausted

required

True when no further runs / lines need scanning

boolean

hits

required

Hits ordered newest-run-first, then ascending line within a run

array | null

object

required

Absolute line number within the run

integer format: int64

run_id

required

ULID of the run containing this line

string

stream

required

Stream identifier (stdout/stderr/system)

string

text

required

Matched line content without trailing newline

string

required

Run created_at in Unix milliseconds (used for newest-first sort)

integer format: int64

next_cursor

Opaque token to fetch the next page; empty when the scan is exhausted

string

scanned_runs

required

Number of runs visited by this request

integer format: int64

Example

{
  "$schema": "http://localhost:9477/schemas/LogSearchBody.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 | 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"
}