Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

feat(core): Add getTraceMetaTags function #13201

Merged
merged 10 commits into from
Aug 6, 2024
Merged

feat(core): Add getTraceMetaTags function #13201

merged 10 commits into from
Aug 6, 2024

Conversation

Lms24
Copy link
Member

@Lms24 Lms24 commented Aug 2, 2024 •
edited
Loading

Following #13134, this PR now exports a second function, getTraceMetaTags that gives users an easy way to get stringified Html meta tags for server->client trace propagation.

Example usage:

app.get('/', (_req, res) => {
  res.send({
    response: `
    <html>
      <head>
        ${Sentry.getTraceMetaTags()}
      </head>
      <body>
        Hi :)
      </body>
    </html>
    `,
  });
});

API design note:

We briefly discussed returning an array of strings per meta tag instead of just one string. If reviewers prefer this, I'm happy to change the API accordingly but my thinking was that users should always add all meta tags returned by this function. Otherwise, the propagated trace state would be inconsistent. So I don't want to hand them an API that suggest they could pick one. Also, returning an array would make the API a tad less convenient to use and there's precedence for the simple string approach, for example in Laravel.

closes #8843
ref #8520

@Lms24 Lms24 mentioned this pull request Aug 2, 2024
Closed
@Lms24 Lms24 self-assigned this Aug 2, 2024
@Lms24 Lms24 marked this pull request as ready for review August 2, 2024 16:39
@Lms24 Lms24 changed the title feat(core): Add getTracingMetaTags function feat(core): Add getTraceMetaTags function Aug 5, 2024
@Lms24 Lms24 requested review from AbhiPrasad and andreiborza August 5, 2024 10:30
@Lms24 Lms24 mentioned this pull request Aug 5, 2024
Merged
andreiborza
andreiborza approved these changes Aug 5, 2024
View reviewed changes
@Lms24 @andreiborza
Update packages/core/src/utils/meta.ts
93b9ef0 
Co-authored-by: Andrei <168741329+andreiborza@users.noreply.github.com>
@Lms24 Lms24 enabled auto-merge (squash) August 5, 2024 16:08
@Lms24 Lms24 disabled auto-merge August 6, 2024 09:15
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 6, 2024 •
edited
Loading

size-limit report 📦

Path Size
@sentry/browser 22.46 KB (0%)
@sentry/browser (incl. Tracing) 34.24 KB (0%)
@sentry/browser (incl. Tracing, Replay) 70.3 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 63.63 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas) 74.69 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback) 87.3 KB (+0.01% 🔺)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics) 89.15 KB (+0.01% 🔺)
@sentry/browser (incl. metrics) 26.76 KB (0%)
@sentry/browser (incl. Feedback) 39.4 KB (0%)
@sentry/browser (incl. sendFeedback) 27.08 KB (0%)
@sentry/browser (incl. FeedbackAsync) 31.73 KB (0%)
@sentry/react 25.22 KB (0%)
@sentry/react (incl. Tracing) 37.24 KB (0%)
@sentry/vue 26.61 KB (0%)
@sentry/vue (incl. Tracing) 36.09 KB (-0.01% 🔽)
@sentry/svelte 22.59 KB (0%)
CDN Bundle 23.68 KB (0%)
CDN Bundle (incl. Tracing) 35.92 KB (0%)
CDN Bundle (incl. Tracing, Replay) 70.34 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) 75.6 KB (0%)
CDN Bundle - uncompressed 69.44 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed 106.35 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed 218.2 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 231.09 KB (0%)
@sentry/nextjs (client) 37.08 KB (0%)
@sentry/sveltekit (client) 34.8 KB (0%)
@sentry/node 114.77 KB (-0.01% 🔽)
@sentry/node - without tracing 89.33 KB (-0.01% 🔽)
@sentry/aws-serverless 98.5 KB (0%)

@Lms24 Lms24 mentioned this pull request Aug 6, 2024
Merged
@Lms24 Lms24 merged commit 05684d4 into develop Aug 6, 2024
123 checks passed
@Lms24 Lms24 deleted the lms/feat-core-metaTags branch August 6, 2024 12:38
@Lms24 Lms24 mentioned this pull request Aug 9, 2024
Closed
@gokulk16 gokulk16 mentioned this pull request Aug 30, 2024
Merged
This was referenced Aug 30, 2024
Open
Open
@tomwwinter tomwwinter mentioned this pull request Aug 30, 2024
Closed
@tomwwinter tomwwinter mentioned this pull request Aug 30, 2024
Open
@q1blue q1blue mentioned this pull request Aug 30, 2024
Open
@angeloreale angeloreale mentioned this pull request Aug 31, 2024
Open
@FengShangWuQi FengShangWuQi mentioned this pull request Sep 1, 2024
Closed
@PierreGode PierreGode mentioned this pull request Sep 4, 2024
Open
This was referenced Sep 4, 2024
Open
Closed
@q1blue q1blue mentioned this pull request Sep 7, 2024
Open
@FengShangWuQi FengShangWuQi mentioned this pull request Sep 8, 2024
Closed
@bagulm123 bagulm123 mentioned this pull request Sep 8, 2024
Open
@KeeghanM KeeghanM mentioned this pull request Sep 12, 2024
Merged
This was referenced Sep 13, 2024
Open
Open
@gokulk16 gokulk16 mentioned this pull request Sep 23, 2024
Open
@q1blue q1blue mentioned this pull request Sep 24, 2024
Open
This was referenced Sep 24, 2024
Open
Open
@FengShangWuQi FengShangWuQi mentioned this pull request Sep 27, 2024
Closed
This was referenced Sep 27, 2024
Open
Open
@bagulm123 bagulm123 mentioned this pull request Oct 1, 2024
Open
@q1blue q1blue mentioned this pull request Oct 1, 2024
Open
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@andreiborza andreiborza andreiborza approved these changes

@AbhiPrasad AbhiPrasad Awaiting requested review from AbhiPrasad

Assignees

@Lms24 Lms24

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add getTracingMetaTags helper function to Node SDK
2 participants
@Lms24 @andreiborza