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
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/v3";
|
|
|
|
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](/trigger-config#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/v3";
|
|
|
|
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;
|
|
},
|
|
});
|
|
```
|