-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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.
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: Pick up sentry-trace in JS <meta/> tag #2703
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
@@ -283,6 +283,52 @@ export class Tracing implements Integration { | |||||||||||||||||||||||||||||||
}); | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
/** | ||||||||||||||||||||||||||||||||
* Returns a new Transaction either continued from sentry-trace meta or a new one | ||||||||||||||||||||||||||||||||
*/ | ||||||||||||||||||||||||||||||||
private static _getNewTransaction(hub: Hub, transactionContext: TransactionContext): Transaction { | ||||||||||||||||||||||||||||||||
let traceId; | ||||||||||||||||||||||||||||||||
let parentSpanId; | ||||||||||||||||||||||||||||||||
let sampled; | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
const header = Tracing._getMeta('sentry-trace'); | ||||||||||||||||||||||||||||||||
if (header) { | ||||||||||||||||||||||||||||||||
const span = SpanClass.fromTraceparent(header); | ||||||||||||||||||||||||||||||||
if (span) { | ||||||||||||||||||||||||||||||||
traceId = span.traceId; | ||||||||||||||||||||||||||||||||
parentSpanId = span.parentSpanId; | ||||||||||||||||||||||||||||||||
sampled = span.sampled; | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
Tracing._log( | ||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This log will be incorrect if |
||||||||||||||||||||||||||||||||
`[Tracing] found 'sentry-meta' '<meta />' continuing trace with: trace_id: ${traceId} span_id: ${parentSpanId}`, | ||||||||||||||||||||||||||||||||
); | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
return hub.startTransaction({ | ||||||||||||||||||||||||||||||||
parentSpanId, | ||||||||||||||||||||||||||||||||
sampled, | ||||||||||||||||||||||||||||||||
traceId, | ||||||||||||||||||||||||||||||||
trimEnd: true, | ||||||||||||||||||||||||||||||||
...transactionContext, | ||||||||||||||||||||||||||||||||
}) as Transaction; | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
/** | ||||||||||||||||||||||||||||||||
* Returns the value of a meta tag | ||||||||||||||||||||||||||||||||
*/ | ||||||||||||||||||||||||||||||||
private static _getMeta(metaName: string): string | null { | ||||||||||||||||||||||||||||||||
const metas = document.getElementsByTagName('meta'); | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
// tslint:disable-next-line: prefer-for-of | ||||||||||||||||||||||||||||||||
for (let i = 0; i < metas.length; i++) { | ||||||||||||||||||||||||||||||||
if (metas[i].getAttribute('name') === metaName) { | ||||||||||||||||||||||||||||||||
return metas[i].getAttribute('content'); | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
return null; | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This has typescript errors, I will go with
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, silly empty object typing 🎳 |
||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
/** | ||||||||||||||||||||||||||||||||
* Pings the heartbeat | ||||||||||||||||||||||||||||||||
*/ | ||||||||||||||||||||||||||||||||
|
@@ -454,10 +500,7 @@ export class Tracing implements Integration { | |||||||||||||||||||||||||||||||
return undefined; | ||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
Tracing._activeTransaction = hub.startTransaction({ | ||||||||||||||||||||||||||||||||
trimEnd: true, | ||||||||||||||||||||||||||||||||
...transactionContext, | ||||||||||||||||||||||||||||||||
}) as Transaction; | ||||||||||||||||||||||||||||||||
Tracing._activeTransaction = Tracing._getNewTransaction(hub, transactionContext); | ||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||
// We set the transaction here on the scope so error events pick up the trace context and attach it to the error | ||||||||||||||||||||||||||||||||
hub.configureScope(scope => scope.setSpan(Tracing._activeTransaction)); | ||||||||||||||||||||||||||||||||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -34,6 +34,7 @@ export function tracingHandler(): ( | |
|
||
let traceId; | ||
let parentSpanId; | ||
let sampled; | ||
|
||
// If there is a trace header set, we extract the data from it and set the span on the scope | ||
// to be the origin an created transaction set the parent_span_id / trace_id | ||
|
@@ -42,13 +43,15 @@ export function tracingHandler(): ( | |
if (span) { | ||
traceId = span.traceId; | ||
parentSpanId = span.parentSpanId; | ||
sampled = span.sampled; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a bug fix right? We should remember for the changelog then that there are two changes in this PR. a |
||
} | ||
} | ||
|
||
const transaction = startTransaction({ | ||
name: `${reqMethod} ${reqUrl}`, | ||
op: 'http.server', | ||
parentSpanId, | ||
sampled, | ||
traceId, | ||
}); | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I guess now if someone sets this in an SPA, all transactions would use this meta header right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct. For me this is opt-in behavior enough, this can't happen by accident so guarding this behind an option in the integration doesn't make a lot of sense to me.