James Ritchie
fade22015f
* Adds new features table to top of v4 upgrade guide * Adds wait idempotency to wait-until, wait-for, and wait-for-token pages * Adds new priority docs page and updates the v4 upgrade guide * Adds new task lifecycle hooks * Removes the message about requiring tasks to be exported * Adds new global lifecycle hooks section * Moves sections from upgrade guide into the table * Adds hidden task page * Improves the global lifecycle hooks section * Updates middleware and locals section * Adds new useWaitToken page to the react hooks section * Adds a new ai.tool section * Moves Docker (legacy) page into self-hosting section * Removes known issues from v4 upgrade guide * Replace “toolTask” with “ai.tool” in the Streams page example * Renames guide to “Migrating from v3” and adds redirect * Remove references to v4 * Removes changelog from migration guide * The installation guide now references `@latest update` * Changes all references from `/sdk/v3` to `/sdk` * Updates @v4-beta to @latest * Fixed broken link * Fixes broken link * Adds an upgrade to v4 using AI section * Fixes 2 broken links * Adds an entry for targetting preview branches * Updates the run statuses * Adds boolean helpers section to the runs and realtime pages * Updates the concurrency page * Updates the test page to include the new options * Adds SDK and curl options for the preview branch targeting * Updates new bulk actions page * Remove the releasing concurrency section * Got rid of some more @v4-beta mentions * Improved rate limit docs * Improved migrating docs * Removed commented sections of the docs * useWaitToken hook * Fixed the description * Fix for missing test image --------- Co-authored-by: Matt Aitken <matt@mattaitken.com> Co-authored-by: Dan <8297864+D-K-P@users.noreply.github.com>
80 lines
2.7 KiB
Plaintext
80 lines
2.7 KiB
Plaintext
---
|
|
title: "Logging and tracing"
|
|
description: "How to use the built-in logging and tracing system."
|
|
---
|
|
|
|
|
|
|
|
The run log shows you exactly what happened in every run of your tasks. It is comprised of logs, traces and spans.
|
|
|
|
## Logs
|
|
|
|
You can use `console.log()`, `console.error()`, etc as normal and they will be shown in your run log. This is the standard function so you can use it as you would in any other JavaScript or TypeScript code. Logs from any functions/packages will also be shown.
|
|
|
|
### logger
|
|
|
|
We recommend that you use our `logger` object which creates structured logs. Structured logs will make it easier for you to search the logs to quickly find runs.
|
|
|
|
```ts /trigger/logging.ts
|
|
import { task, logger } from "@trigger.dev/sdk";
|
|
|
|
export const loggingExample = task({
|
|
id: "logging-example",
|
|
run: async (payload: { data: Record<string, string> }) => {
|
|
//the first parameter is the message, the second parameter must be a key-value object (Record<string, unknown>)
|
|
logger.debug("Debug message", payload.data);
|
|
logger.log("Log message", payload.data);
|
|
logger.info("Info message", payload.data);
|
|
logger.warn("You've been warned", payload.data);
|
|
logger.error("Error message", payload.data);
|
|
},
|
|
});
|
|
```
|
|
|
|
## Tracing and spans
|
|
|
|
Tracing is a way to follow the flow of your code. It's very useful for debugging and understanding how your code is working, especially with long-running or complex tasks.
|
|
|
|
Trigger.dev uses OpenTelemetry tracing under the hood. With automatic tracing for many things like task triggering, task attempts, HTTP requests, and more.
|
|
|
|
| Name | Description |
|
|
| :------------ | :------------------------------- |
|
|
| Task triggers | Task triggers |
|
|
| Task attempts | Task attempts |
|
|
| HTTP requests | HTTP requests made by your code. |
|
|
|
|
### Adding instrumentations
|
|
|
|
|
|
|
|
You can [add instrumentations](/config/config-file#instrumentations). The Prisma one above will automatically trace all Prisma queries.
|
|
|
|
### Add custom traces
|
|
|
|
If you want to add custom traces to your code, you can use the `logger.trace` function. It will create a new OTEL trace and you can set attributes on it.
|
|
|
|
```ts
|
|
import { logger, task } from "@trigger.dev/sdk";
|
|
|
|
export const customTrace = task({
|
|
id: "custom-trace",
|
|
run: async (payload) => {
|
|
//you can wrap code in a trace, and set attributes
|
|
const user = await logger.trace("fetch-user", async (span) => {
|
|
span.setAttribute("user.id", "1");
|
|
|
|
//...do stuff
|
|
|
|
//you can return a value
|
|
return {
|
|
id: "1",
|
|
name: "John Doe",
|
|
fetchedAt: new Date(),
|
|
};
|
|
});
|
|
|
|
const usersName = user.name;
|
|
},
|
|
});
|
|
```
|