
Max duration
Set a maximum duration for a task to run.
The maxDuration
parameter sets a maximum compute time limit for tasks. When a task exceeds this duration, it will be automatically stopped. This helps prevent runaway tasks and manage compute resources effectively.
You must set a default maxDuration in your trigger.config.ts
file, which will apply to all tasks unless overridden:
The minimum maxDuration is 5 seconds. If you want to avoid timeouts, set this value to a very large number of seconds.
You can set the maxDuration
for a run in the following ways:
- Across all your tasks in the config
- On a specific task
- On a specific run when you trigger a task
How it works
The maxDuration
is set in seconds, and is compared to the CPU time elapsed since the start of a single execution (which we call attempts) of the task. The CPU time is the time that the task has been actively running on the CPU, and does not include time spent waiting during the following:
wait.for
callstriggerAndWait
callsbatchTriggerAndWait
calls
You can inspect the CPU time of a task inside the run function with our usage
utility:
The above value will be compared to the maxDuration
you set. If the task exceeds the maxDuration
, it will be stopped with the following error:
Configuring for a task
You can set a maxDuration
on a specific task:
This will override the default maxDuration
set in the config file. If you have a config file with a default maxDuration
of 60 seconds, and you set a maxDuration
of 300 seconds on a task, the task will run for 300 seconds.
You can “turn off” the Max duration set in your config file for a specific task like so:
Configuring for a run
You can set a maxDuration
on a specific run when you trigger a task:
You can also set the maxDuration
to timeout.None
to turn off the max duration for a specific run:
maxDuration in run context
You can access the maxDuration
set for a run in the run context:
maxDuration and lifecycle functions
When a task run exceeds the maxDuration
, the lifecycle functions cleanup
, onSuccess
, and onFailure
will not be called.