Ruby SDKFeature Clients

Logs Client

Logs client for interacting with Hatchet's logs API.

This class provides a high-level interface for listing log lines associated with task runs in the Hatchet system.

logs = hatchet.logs.list("task-run-id", limit: 100)

It is available on the main client as hatchet.logs.

Methods:

NameDescription
listList log lines for a given task run.

Functions

list

List log lines for a given task run.

logs = hatchet.logs.list("task-run-123", limit: 500, since: Time.now - 3600)

Parameters:

NameTypeDescriptionDefault
task_run_idStringThe ID of the task run to list logs for.required
limitIntegerMaximum number of log lines to return (default: 1000)1000
sinceTime | nilThe start time to get logs for.nil
until_timeTime | nilThe end time to get logs for.nil

Returns:

TypeDescription
ObjectA list of log lines for the specified task run.

Raises:

TypeDescription
HatchetSdkRest::ApiErrorIf the API request fails.

Last updated on August 24, 2026

On this page