James Ritchie
6270abaab8
* Make the tooltip text color grey so it’s readable again the primary color * Setup and styling for the Guides section * Better Guides icon * Improved the prerequisites * WIP Nextjs guide and new folder structures * Copy updates * Useful next steps is now a snippet * Better icons for the next steps section * Renamed the “prerequisites” snippet * Node.js guide * Added a “Creating a project” guide * New snippet for prerequisites * New Remix guide * Added Remix to the side bar * Tweaked icons for creating a project page * Added the hello world step to the onboarding steps * Better “useful next steps” snippet card links * Moved prerequisites * Fixing links to images * Moved v2 migration page to guides * Removed dead link * Attempt fix for redirect * Fixed redirects * Getting started section includes link to roadmap * Removed icon from side menu * Deleted all v2 pages (excluding updating mint.json) * Removed v2 pages, redirects and versions from mint.json * Deleted v2 snippets * Deleted un-used pages * Set of more useful coming soon snippets * All snippets use the updated format * updated folder “v3/“ with “/pages” * Moved all main docs files to the route and updated the redirect * Fixed URLs in the mdx pages to the new route path * URL goes to the proper pricing page * Better delayed runs image * Attempt fix for self hosting page not redirecting
110 lines
3.2 KiB
Plaintext
110 lines
3.2 KiB
Plaintext
---
|
|
title: "Usage"
|
|
description: "Get compute duration and cost from inside a run, or for a specific block of code."
|
|
---
|
|
|
|
## Getting the run cost and duration
|
|
|
|
You can get the cost and duration of the current including retries of the same run.
|
|
|
|
```ts
|
|
export const heavyTask = task({
|
|
id: "heavy-task",
|
|
machine: {
|
|
preset: "medium-2x",
|
|
},
|
|
run: async (payload, { ctx }) => {
|
|
// Do some compute
|
|
const result = await convertVideo(payload.videoUrl);
|
|
|
|
// Get the current cost and duration up until this line of code
|
|
// This includes the compute time of the previous lines
|
|
let currentUsage = usage.getCurrent();
|
|
/* currentUsage = {
|
|
compute: {
|
|
attempt: {
|
|
costInCents: 0.01700,
|
|
durationMs: 1000,
|
|
},
|
|
total: {
|
|
costInCents: 0.0255,
|
|
durationMs: 1500,
|
|
},
|
|
},
|
|
baseCostInCents: 0.0025,
|
|
totalCostInCents: 0.028,
|
|
}
|
|
*/
|
|
|
|
// In the cloud product we do not count waits towards the compute cost or duration.
|
|
// We also don't include time between attempts or before the run starts executing your code.
|
|
// So this line does not affect the cost or duration.
|
|
await wait.for({ seconds: 5 });
|
|
|
|
// This will give the same result as before the wait.
|
|
currentUsage = usage.getCurrent();
|
|
|
|
// Do more compute
|
|
const result = await convertVideo(payload.videoUrl);
|
|
|
|
// This would give a different value
|
|
currentUsage = usage.getCurrent();
|
|
},
|
|
});
|
|
```
|
|
|
|
<Note>
|
|
In Trigger.dev cloud we do not include time between attempts, before your code executes, or waits
|
|
towards the compute cost or duration.
|
|
</Note>
|
|
|
|
## Getting the run cost and duration from your backend
|
|
|
|
You can use [runs.retrieve()](/management/runs/retrieve) to get a single run or [runs.list()](/management/runs/list) to get a list of runs. The response will include `costInCents` `baseCostInCents` and `durationMs` fields.
|
|
|
|
```ts single run
|
|
import { runs } from "@trigger.dev/sdk/v3";
|
|
|
|
const run = await runs.retrieve("run-id");
|
|
console.log(run.costInCents, run.baseCostInCents, run.durationMs);
|
|
const totalCost = run.costInCents + run.baseCostInCents;
|
|
```
|
|
|
|
```ts multiple runs
|
|
import { runs } from "@trigger.dev/sdk/v3";
|
|
|
|
let totalCost = 0;
|
|
for await (const run of runs.list({ tag: "user_123456" })) {
|
|
totalCost += run.costInCents + run.baseCostInCents;
|
|
console.log(run.costInCents, run.baseCostInCents, run.durationMs);
|
|
}
|
|
|
|
console.log("Total cost", totalCost);
|
|
```
|
|
|
|
## Getting the cost and duration of a block of code
|
|
|
|
You can also wrap code with `usage.measure` to get the cost and duration of that block of code:
|
|
|
|
```ts
|
|
// Inside a task run function, or inside a function that's called from there.
|
|
const { result, compute } = await usage.measure(async () => {
|
|
//...Do something for 1 second
|
|
return {
|
|
foo: "bar",
|
|
};
|
|
});
|
|
|
|
logger.info("Result", { result, compute });
|
|
/* result = {
|
|
foo: "bar"
|
|
}
|
|
compute = {
|
|
costInCents: 0.01700,
|
|
durationMs: 1000,
|
|
}
|
|
*/
|
|
```
|
|
|
|
This will work from inside the `run` function, our lifecycle hooks (like `onStart`, `onFailure`, `onSuccess`, etc.), or any function you're calling from the `run` function. It won't work for code that's not executed using Trigger.dev.
|