The logs method retrieves workflow run logs using the List Workflow Runs API.
Arguments#
A pagination cursor from a previous request. Use this to fetch the next set of results.
Maximum number of runs to return. Defaults to a system-defined value if not specified.
Filter options for narrowing down workflow run logs.
Show propertiesHide properties
Filter by a specific workflow run ID.
Filter workflow runs by execution state.
| State | Description |
|---|---|
RUN_STARTED | The workflow run is in progress. |
RUN_SUCCESS | The workflow run completed successfully. |
RUN_FAILED | The run failed after all retries. |
RUN_CANCELED | The run was manually canceled. |
Filter by the exact workflow URL.
Filter by workflow label. Pass an array to match runs that have any of the given labels (OR semantics).
Filter by the workflow creation time (Unix timestamp).
Filter by a specific message ID.
Filter workflow runs created after this date.
Filter workflow runs created before this date.
Filter by the IP address that triggered the workflow.
Filter by flow control key.
Response#
A cursor to use for pagination. If no cursor is returned, there are no more workflow runs.
Show propertiesHide properties
The ID of the workflow run.
The URL address of the workflow endpoint.
The current state of the workflow run at this point in time
| Value | Description |
|---|---|
RUN_STARTED | The workflow has started to run and currently in progress. |
RUN_SUCCESS | The workflow run has completed succesfully. |
RUN_FAILED | Some errors has occured and workflow failed after all retries. |
RUN_CANCELED | The workflow run has canceled upon user request. |
The Unix timestamp (in milliseconds) when the workflow run started.
The Unix timestamp (in milliseconds) when the workflow run was completed, if applicable.
The labels of the run assigned by the user on trigger.
Deprecated. Use labels instead. When a run has multiple labels, this only
contains the first one.
The details of the failure callback message, if a failure function was defined for the workflow.
Show propertiesHide properties
The ID of the failure callback message
The URL address of the failure function
The state of the failure callback
| Value |
|---|
CALLBACK_INPROGRESS |
CALLBACK_SUCCESS |
CALLBACK_FAIL |
The HTTP headers of the message that triggered the failure function.
The HTTP response status of the message that triggered the failure function.
The response body of the message that triggered the failure function.
The DLQ ID of the workflow run.
Response body of the failure function/url. When failure function is used, this contains the returned message from the failure function.
Reponse headers of the failure function/url. This is valuable when the call to run the failure function/url is rejected because of a platform limit.
Reponse status of the failure function/url. This is valuable when the call to run the failure function/url is rejected because of a platform limit.
A call to failure url/function can be retried as maxRetries time. This array contains errors of all retry
attempts.
Show propertiesHide properties
Response status of the endpoint that caused the error
Response Headers of the endpoint that caused the error
Response Body of the endpoint that caused the error if available
An error message that happened before/after calling the user’s endpoint.
The time of the error happened in Unix time milliseconds
Max number of retries configured when seeing an error.
Show propertiesHide properties
The type of grouped steps
| Value | Description |
|---|---|
sequential | Indicates only one step is excuted sequentially |
parallel | Indicates multiple steps being executed in parallel. |
next | Indicates there is information about currently executing step(s) |
Show propertiesHide properties
The ID of the step which increases monotonically.
The name of the step. It is specified in workflow by user.
Execution type of the step which indicates type of the context function.
| Value | Function |
|---|---|
Initial | The default step which created automatically |
Run | context.run() |
Call | context.call() |
SleepFor | context.sleepFor() |
SleepUntil | context.sleepUntil() |
Wait | context.waitForEvent() |
Notify | context.notify() |
Invoke | context.invoke() |
The ID of the message associated with this step.
The output returned by the step
The total number of concurrent steps that is running alongside this step
The state of this step at this point in time
| Value |
|---|
STEP_SUCCESS |
STEP_RETRY |
STEP_FAILED |
STEP_CANCELED |
The unix timestamp in milliseconds when the message associated with this step has created.
The unix timestamp in milliseconds when this step will be retried.
This is set only when the step state is STEP_RETRY
The following fields are set only when a specific type of step is executing. These fields are not available for all step types.
The duration in milliseconds which step will sleep. Only set if stepType is SleepFor.
The unix timestamp (in milliseconds) which step will sleep until. Only set if stepType is SleepUntil.
The event id of the wait step. Only set if stepType is Wait.
The unix timestamp (in milliseconds) when the wait will time out.
The duration of timeout in human readable format (e.g. 120s, 1m, 1h).
Set to true if this step is cause of a wait timeout rather than notifying the waiter.
The URL of the external address. Available only if stepType is Call.
The HTTP method of the request sent to the external address. Available only if stepType is Call.
The HTTP headers of the request sent to the external address. Available only if stepType is Call.
The body of the request sent to the external address. Available only if stepType is Call.
The HTTP status returned by the external call. Available only if stepType is Call.
The body returned by the external call. Available only if stepType is Call.
The HTTP headers returned by the external call. Available only if stepType is Call.
The ID of the invoked workflow run if this step is an invoke step.
The URL address of the workflow server of invoked workflow run if this step is an invoke step.
The Unix timestamp (in milliseconds) when the invoked workflow was started if this step is an invoke step.
The body passed to the invoked workflow if this step is an invoke step.
The HTTP headers passed to invoked workflow if this step is an invoke step.
Usage#
import { Client } from "@upstash/workflow";const client = new Client({ token: "<QSTASH_TOKEN>" })const { runs, cursor } = await client.logs()Paginate with cursor#
const allRuns = [];let cursor: string | undefined;do { const result = await client.logs({ cursor }); allRuns.push(...result.runs); cursor = result.cursor;} while (cursor);Filter by state#
const { runs } = await client.logs({ filter: { state: "RUN_FAILED", }})Filter by label and date range#
const { runs } = await client.logs({ filter: { label: "my-workflow", fromDate: new Date("2024-01-01"), toDate: new Date("2024-06-01"), }})Filter by multiple labels#
Passing an array matches runs that have any of the given labels (OR semantics).
For example, with runs labelled ["label-1", "label-2"] and ["label-2", "label-3"],
filtering by ["label-1", "label-2"] returns both.
const { runs } = await client.logs({ filter: { label: ["label-1", "label-2"], }})