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.

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

Distrubited Tracing Tutorial #11518

Merged
merged 36 commits into from
Oct 29, 2024
Merged

Distrubited Tracing Tutorial #11518

merged 36 commits into from
Oct 29, 2024

Conversation

coolguyzone
Copy link
Collaborator

@coolguyzone coolguyzone commented Oct 8, 2024

…through

DESCRIBE YOUR PR

A new interactive tutorial to get set up with Sentry and distributed tracing.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Copy link

vercel bot commented Oct 8, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
changelog ❌ Failed (Inspect) Oct 25, 2024 9:46pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 25, 2024 9:46pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Oct 25, 2024 9:46pm

Copy link

codecov bot commented Oct 8, 2024

Bundle Report

Changes will increase total bundle size by 2.02kB (0.01%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.45MB 1.56kB (0.02%) ⬆️
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.42MB 468 bytes (0.01%) ⬆️

Copy link
Contributor

@lizokm lizokm left a comment

Choose a reason for hiding this comment

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

This is looking super solid! Just a few more tweaks and it will be ready to merge.

Comment on lines 44 to 46
1. Go back to the browser window and try clicking on the **Nonfat Water** button again, you will no longer see the expected product information. Instead, you'll see text saying something went wrong. If you look at line 88 of the `App.js` file in the `tracing-tutorial-frontend` repo, you'll see this is what the frontend displays when it's call to the backend doesn't return any data.

1. Open the terminal window that's running the `tracing-tutorial-backend` server. Here, you'll see that a log letting you know that an error has occurred.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. Go back to the browser window and try clicking on the **Nonfat Water** button again, you will no longer see the expected product information. Instead, you'll see text saying something went wrong. If you look at line 88 of the `App.js` file in the `tracing-tutorial-frontend` repo, you'll see this is what the frontend displays when it's call to the backend doesn't return any data.
1. Open the terminal window that's running the `tracing-tutorial-backend` server. Here, you'll see that a log letting you know that an error has occurred.
1. Go back to the browser window and click the **Nonfat Water** button again. Instead of seeing the expected product information, you'll now see text telling you that something went wrong. If you look at line 88 of the `App.js` file in the `tracing-tutorial-frontend` repo, you'll see this is what the frontend displays when its call to the backend doesn't return any data.
1. Open the terminal window that's running the `tracing-tutorial-backend` server. You'll see a log letting you know that an error has occurred.

* Make tech stack clearer earlier in text

* Split long paragraph

* Remove text that probably makes no sense if you are a first time user

* Explain DSN in context of the screen a user is currently on

* It is clearer in one sentence

* Put instructions in corre t order

* Move comment

* Add new bullet point for importing instrument into server.js

* Looks clearer as a diff

* Depending on user preferences in their IDE, this might not be line 88, e.g. line length settings

* Fix typo
@coolguyzone coolguyzone changed the title Tracing Demo DRAFT Distrubited Tracing Tutorial Oct 28, 2024
@coolguyzone coolguyzone merged commit b6290f7 into master Oct 29, 2024
10 of 11 checks passed
@coolguyzone coolguyzone deleted the tracing-tutorial branch October 29, 2024 16:28
@github-actions github-actions bot locked and limited conversation to collaborators Nov 14, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants