Skip to content
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

feat(remix): Set sentry-trace <meta> on server-side. #5440

Merged
merged 2 commits into from
Jul 25, 2022
Merged

feat(remix): Set sentry-trace <meta> on server-side. #5440

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a1f8d7
feat(remix): Set `sentry-trace` `<meta>` on server-side.
onurtemizkan Jul 21, 2022
4302c7b
Add transaction `baggage` as a `<meta>`.
onurtemizkan Jul 22, 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
46 changes: 46 additions & 0 deletions packages/remix/src/utils/instrumentServer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
/* eslint-disable max-lines */
import { captureException, getCurrentHub } from '@sentry/node';
import { getActiveTransaction } from '@sentry/tracing';
import { addExceptionMechanism, fill, loadModule, logger, stripUrlQueryAndFragment } from '@sentry/utils';
Expand All @@ -20,11 +21,26 @@ interface Route {
parentId?: string;
path?: string;
}
export interface RouteData {
[routeId: string]: AppData;
}

export interface MetaFunction {
(args: { data: AppData; parentsData: RouteData; params: Params; location: Location }): HtmlMetaDescriptor;
}

export interface HtmlMetaDescriptor {
[name: string]: null | string | undefined | Record<string, string> | Array<Record<string, string> | string>;
charset?: 'utf-8';
charSet?: 'utf-8';
title?: string;
}

interface ServerRouteModule {
action?: DataFunction;
headers?: unknown;
loader?: DataFunction;
meta?: MetaFunction | HtmlMetaDescriptor;
}

interface ServerRoute extends Route {
Expand Down Expand Up @@ -206,6 +222,34 @@ function makeWrappedLoader(origAction: DataFunction): DataFunction {
return makeWrappedDataFunction(origAction, 'loader');
}

function makeWrappedMeta(origMeta: MetaFunction | HtmlMetaDescriptor = {}): MetaFunction {
return function (
this: unknown,
args: { data: AppData; parentsData: RouteData; params: Params; location: Location },
): HtmlMetaDescriptor {
let origMetaResult;
if (origMeta instanceof Function) {
origMetaResult = origMeta.call(this, args);
} else {
origMetaResult = origMeta;
}

const scope = getCurrentHub().getScope();
if (scope) {
const span = scope.getSpan();

if (span) {
return {
...origMetaResult,
'sentry-trace': span.toTraceparent(),
Copy link
Member

Choose a reason for hiding this comment

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

So just to confirm, this adds a meta tag to the html that looks as follows?:

<meta name="sentry-trace" content="..." />

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, that's correct. (docs) Also tested manually. 👍

Copy link
Member

Choose a reason for hiding this comment

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

RE: baggage meta tag

Don't take this suggestion literally (e.g. still needs imports and all) but I think this is how it could work.

Slightly above, get the active transaction (from the scope) and then here:

Suggested change
'sentry-trace': span.toTraceparent(),
'sentry-trace': span.toTraceparent(),
baggage: serializeBaggage(transaction.getBaggage()),

};
}
}

return origMetaResult;
};
}

function wrapRequestHandler(origRequestHandler: RequestHandler): RequestHandler {
return async function (this: unknown, request: Request, loadContext?: unknown): Promise<Response> {
const hub = getCurrentHub();
Expand Down Expand Up @@ -247,6 +291,8 @@ function makeWrappedCreateRequestHandler(
for (const [id, route] of Object.entries(build.routes)) {
const wrappedRoute = { ...route, module: { ...route.module } };

fill(wrappedRoute.module, 'meta', makeWrappedMeta);

if (wrappedRoute.module.action) {
fill(wrappedRoute.module, 'action', makeWrappedAction);
}
Expand Down