Skip to content

Explain how to set baggage and sentry-trace meta tags on Remix. #5377

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 5, 2022
Merged

Explain how to set baggage and sentry-trace meta tags on Remix. #5377

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f83b49
Explain how to set `baggage` and `sentry-trace` meta tags on Remix.
onurtemizkan Aug 3, 2022
c51fa65
Add version warning (exact version to be updated).
onurtemizkan Aug 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/includes/performance/connect-services/javascript.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,29 @@ For traces that begin in your backend, you can connect the automatically-generat
</html>
```

<PlatformSection supported={["javascript.remix"]} notSupported={["javascript"]}>

Remix SDK attaches `sentry-trace` and `baggage` values from your `root` loader. You need to use [`meta`](https://remix.run/docs/en/v1/api/conventions#meta) function to attach the data from your `loader` as `<meta>` tags. The following code snippet shows how to do this:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We’ll need to add a note about minimum SDK version here?


```typescript {filename: root.tsx}
export const meta: MetaFunction = ({data}) => {
return {
// ...
'sentry-trace': data.sentryTrace,
baggage: data.sentryBaggage,
};
};
```

<Alert level="warning" title="Support">

This feature is available on Sentry Remix SDK version 7.9.0 and above.

</Alert>

</PlatformSection>


The `name` attributes must be the strings `"sentry-trace"` and `"baggage"` and the `content` attributes must be generated by your backend Sentry SDK. For `sentry-trace`, use `span.toSentryTrace()` (or equivalent, depending on the backend platform). This guarantees that a new and unique value will be generated for each request. For `baggage`, use `serializeBaggage(span.getBaggage())`.
<Note>

Expand Down