Logs

Changed on
post/logs/global/search

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/logs/global/search
  • Auth: HTTP bearer

Request body

attrsstring[]

Attribute predicates (ADR-047 §5): <key><op><value> with op one of =, !=, ^= (prefix), >, <, or <key>? for "exists". Requires the line index; when combined with text, the text filter is applied in memory over the lines the index already matched (the index holds no message bytes, so it cannot answer text on its own).

container_idsstring[]

Docker container IDs.

cursorstring nullable

Opaque cursor from the previous page's next_cursor.

deploy_idinteger nullable
end_timestring required
envsstring[]
external_servicesstring[]

Database/service IDs or names, not container service labels.

levelsLogLevel[]
node_idsinteger[]
page_sizeinteger nullable

Defaults to 200, server-capped at 1000.

projectsstring[]

Match project ID, slug or name. Empty selects all authorized projects.

scopesstring[]

Explicit resource identities, e.g. application:12 or service:34.

servicesstring[]

Container service labels (the service column), e.g. web, worker.

source'collected' | 'application' | 'service'

Which family of log sources a query covers.

start_timestring required
textstring nullable

Case-insensitive substring match over the message.

Response

next_cursorstring nullable

Opaque cursor for the next (older) page, or None on the last page.

This is a keyset position over the store's own sort order, so page 40 costs what page 1 costs. Stays populated on a partial page too — that is the whole point: the user can press Next to keep searching.

partialboolean required

true when the store's time/byte budget ran out before this page could be proven complete (scanned_back_to explains how far).

scanned_back_tostring nullable

Set when partial is true: every chunk ending after this timestamp has been searched, nothing older has yet.

Changes

  • 4b228ebed583Revision changes
    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property to the response with the status

  • 1dc3e6788214Revision changes
    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ///////////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property ////// from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ///////////// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status