docs: Max duration

docs/config/config-file.mdx

@@ -152,6 +152,21 @@ export default defineConfig({
 
 The `logLevel` only determines which logs are sent to the Trigger.dev instance when using the `logger` API. All `console` based logs are always sent.
 
+## Max duration
+
+You can set the default `maxDuration` for all tasks in your project:
+
+```ts trigger.config.ts
+import { defineConfig } from "@trigger.dev/sdk/v3";
+
+export default defineConfig({
+  //..other stuff
+  maxDuration: 60, // 60 seconds
+});
+```
+
+See our [maxDuration guide](/runs/max-duration) for more information.
+
 ## Build configuration
 
 You can customize the build process using the `build` option:

docs/mint.json

@@ -1,7 +1,10 @@
 {
   "$schema": "https://mintlify.com/schema.json",
   "name": "Trigger.dev",
-  "openapi": ["/openapi.yml", "/v3-openapi.yaml"],
+  "openapi": [
+    "/openapi.yml",
+    "/v3-openapi.yaml"
+  ],
   "api": {
     "playground": {
       "mode": "simple"
@@ -103,26 +106,41 @@
   "navigation": [
     {
       "group": "Getting Started",
-      "pages": ["introduction", "quick-start", "how-it-works", "upgrading-beta", "limits"]
+      "pages": [
+        "introduction",
+        "quick-start",
+        "how-it-works",
+        "upgrading-beta",
+        "limits"
+      ]
     },
     {
       "group": "Fundamentals",
       "pages": [
         {
           "group": "Tasks",
-          "pages": ["tasks/overview", "tasks/scheduled"]
+          "pages": [
+            "tasks/overview",
+            "tasks/scheduled"
+          ]
         },
         "triggering",
         "apikeys",
         {
           "group": "Configuration",
-          "pages": ["config/config-file", "config/extensions/overview"]
+          "pages": [
+            "config/config-file",
+            "config/extensions/overview"
+          ]
         }
       ]
     },
     {
       "group": "Development",
-      "pages": ["cli-dev", "run-tests"]
+      "pages": [
+        "cli-dev",
+        "run-tests"
+      ]
     },
     {
       "group": "Deployment",
@@ -132,7 +150,9 @@
         "github-actions",
         {
           "group": "Deployment integrations",
-          "pages": ["vercel-integration"]
+          "pages": [
+            "vercel-integration"
+          ]
         }
       ]
     },
@@ -144,16 +164,22 @@
         "errors-retrying",
         {
           "group": "Wait",
-          "pages": ["wait", "wait-for", "wait-until", "wait-for-event", "wait-for-request"]
+          "pages": [
+            "wait",
+            "wait-for",
+            "wait-until",
+            "wait-for-event",
+            "wait-for-request"
+          ]
         },
         "queue-concurrency",
         "versioning",
         "machines",
         "idempotency",
         "replaying",
+        "runs/max-duration",
         "tags",
         "runs/metadata",
-        "notifications",
         "run-usage"
       ]
     },
@@ -163,7 +189,10 @@
         "management/overview",
         {
           "group": "Tasks API",
-          "pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
+          "pages": [
+            "management/tasks/trigger",
+            "management/tasks/batch-trigger"
+          ]
         },
         {
           "group": "Runs API",
@@ -202,7 +231,9 @@
         },
         {
           "group": "Projects API",
-          "pages": ["management/projects/runs"]
+          "pages": [
+            "management/projects/runs"
+          ]
         }
       ]
     },
@@ -248,7 +279,11 @@
     },
     {
       "group": "Help",
-      "pages": ["community", "help-slack", "help-email"]
+      "pages": [
+        "community",
+        "help-slack",
+        "help-email"
+      ]
     },
     {
       "group": "Frameworks",
@@ -272,7 +307,10 @@
     },
     {
       "group": "Guides",
-      "pages": ["guides/frameworks/prisma", "guides/frameworks/sequin"]
+      "pages": [
+        "guides/frameworks/prisma",
+        "guides/frameworks/sequin"
+      ]
     },
     {
       "group": "Example tasks",
@@ -295,16 +333,20 @@
     },
     {
       "group": "Dashboard",
-      "pages": ["guides/dashboard/creating-a-project"]
+      "pages": [
+        "guides/dashboard/creating-a-project"
+      ]
     },
     {
       "group": "Migrations",
-      "pages": ["guides/use-cases/upgrading-from-v2"]
+      "pages": [
+        "guides/use-cases/upgrading-from-v2"
+      ]
     }
   ],
   "footerSocials": {
     "twitter": "https://twitter.com/triggerdotdev",
     "github": "https://github.com/triggerdotdev",
     "linkedin": "https://www.linkedin.com/company/triggerdotdev"
   }
-}
+}

docs/runs/max-duration.mdx

@@ -0,0 +1,138 @@
+---
+title: "Max duration"
+sidebarTitle: "Max duration"
+description: "Set a maximum duration for a task to run."
+---
+
+By default tasks can execute indefinitely, which can be great! But you also might want to set a `maxDuration` to prevent a task from running too long. You can set the `maxDuration` for a run in the following ways:
+
+- Across all your tasks in the [config](/config/config-file#max-duration)
+- On a specific task
+- On a specific run when you [trigger a task](/triggering#maxduration)
+
+## 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` calls
+- `triggerAndWait` calls
+- `batchTriggerAndWait` calls
+
+You can inspect the CPU time of a task inside the run function with our `usage` utility:
+
+```ts /trigger/max-duration.ts
+import { task, usage } from "@trigger.dev/sdk/v3";
+
+export const maxDurationTask = task({
+  id: "max-duration-task",
+  maxDuration: 300, // 300 seconds or 5 minutes
+  run: async (payload: any, { ctx }) => {
+    let currentUsage = usage.getCurrent();
+
+    currentUsage.attempt.durationMs; // The CPU time in milliseconds since the start of the run
+  },
+});
+```
+
+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:
+
+![Max duration error](/runs/max-duration-error.png)
+
+<Note>The minimum maxDuration is 5 seconds. The maximum is ~68 years.</Note>
+
+## Configuring a default max duration
+
+You can set a default `maxDuration` for all tasks in your [config file](/config/config-file#default-machine). This will apply to all tasks unless you override it on a specific task or run.
+
+```ts /config/default-max-duration.ts
+import { defineConfig } from "@trigger.dev/sdk/v3";
+
+export default defineConfig({
+  //Your project ref (you can see it on the Project settings page in the dashboard)
+  project: "proj_gtcwttqhhtlasxgfuhxs",
+  maxDuration: 60, // 60 seconds or 1 minute
+});
+```
+
+## Configuring for a task
+
+You can set a `maxDuration` on a specific task:
+
+```ts /trigger/max-duration-task.ts
+import { task } from "@trigger.dev/sdk/v3";
+
+export const maxDurationTask = task({
+  id: "max-duration-task",
+  maxDuration: 300, // 300 seconds or 5 minutes
+  run: async (payload: any, { ctx }) => {
+    //...
+  },
+});
+```
+
+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:
+
+```ts /trigger/max-duration-task.ts
+import { task, timeout } from "@trigger.dev/sdk/v3";
+
+export const maxDurationTask = task({
+  id: "max-duration-task",
+  maxDuration: timeout.None, // No max duration
+  run: async (payload: any, { ctx }) => {
+    //...
+  },
+});
+```
+
+## Configuring for a run
+
+You can set a `maxDuration` on a specific run when you trigger a task:
+
+```ts /trigger/max-duration.ts
+import { maxDurationTask } from "./trigger/max-duration-task";
+
+// Trigger the task with a maxDuration of 300 seconds
+const run = await maxDurationTask.trigger(
+  { foo: "bar" },
+  {
+    maxDuration: 300, // 300 seconds or 5 minutes
+  }
+);
+```
+
+You can also set the `maxDuration` to `timeout.None` to turn off the max duration for a specific run:
+
+```ts /trigger/max-duration.ts
+import { maxDurationTask } from "./trigger/max-duration-task";
+import { timeout } from "@trigger.dev/sdk/v3";
+
+// Trigger the task with no maxDuration
+const run = await maxDurationTask.trigger(
+  { foo: "bar" },
+  {
+    maxDuration: timeout.None, // No max duration
+  }
+);
+```
+
+## maxDuration in run context
+
+You can access the `maxDuration` set for a run in the run context:
+
+```ts /trigger/max-duration-task.ts
+import { task } from "@trigger.dev/sdk/v3";
+
+export const maxDurationTask = task({
+  id: "max-duration-task",
+  maxDuration: 300, // 300 seconds or 5 minutes
+  run: async (payload: any, { ctx }) => {
+    console.log(ctx.run.maxDuration); // 300
+  },
+});
+```
+
+## maxDuration and lifecycle functions
+
+When a task run exceeds the `maxDuration`, the lifecycle functions `cleanup`, `onSuccess`, and `onFailure` will not be called.