Matt Aitken
de302858f8
* Started building out the docs navigation * Drafted out a lot of the docs pages. With just titles and descriptions with a coming soon message for now. * A ton more scaffolded pages with titles, descriptions, coming soon/incomplete docs messages * Created the remaining page stubs * Introduction page improvements * Lots of docs changes, mostly the task overview page * Moved some bits around * Task overview fleshed out * Triggering docs page * Regular task page * CLi dev docs * Docs for debugging locally * Environment variables docs * Added env var images * Deployment guides * Updated the title of “Integrations” to “Deployment integrations” to make it less confusing * Lots more docs pages * Changed the language to JavaScript * Fixed typos about queues and added a simple code sample * Moved the local debugger docs into the CLI dev page * Added the CLI deploy options * Delete the local debugger page * Updated the logging page with structured logging * Added the new CLI deploy options * Change to h4 for one of the options * Errors page * WIP on retrying * Retrying guide * Wait docs pages * Queuing docs simplified, partial written * Queuing and concurrency docs * Run tests docs * New combined error and retrying page * Errors and retrying page updated * More docs * Added a possible configurations coming soon table * Created a limits page * Added warnings about how you need to get early access * Minor fixes for the docs
80 lines
2.9 KiB
Plaintext
80 lines
2.9 KiB
Plaintext
---
|
|
title: "Logging and tracing"
|
|
description: "How to use the built-in logging and tracing system."
|
|
---
|
|
|
|
|
|
|
|
The [run log](/v3/dashboard-runs) 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.
|
|
|
|
### Automatic instrumentation
|
|
|
|
| Name | Description |
|
|
| ------------- | -------------------------------- |
|
|
| Task triggers | Task triggers. |
|
|
| Task attempts | Task attempts. |
|
|
| HTTP requests | HTTP requests made by your code. |
|
|
| OpenAI | OpenAI SDK calls. |
|
|
|
|
We want to provide automatic instrumentation for as many things as possible. Please do [request any automatic instrumentation](https://github.com/triggerdotdev/trigger.dev/issues/new?template=instrumentation_request.yml) you would like to see.
|
|
|
|
## 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;
|
|
},
|
|
});
|
|
```
|