Skip to content

feat: JS performance docs #2133

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

Closed
wants to merge 2 commits into from
Closed

feat: JS performance docs #2133

wants to merge 2 commits into from

Conversation

HazAT
Copy link
Member

@HazAT HazAT commented Aug 31, 2020

This moved part of the JS specific performance documentation into the JavaScript section.

To make what's written in the Filter out unwanted Spans section 100% true, we need to release this PR first.
getsentry/sentry-javascript#2867

@HazAT HazAT requested a review from a team as a code owner August 31, 2020 12:12
@HazAT HazAT self-assigned this Aug 31, 2020
@vercel
Copy link

vercel bot commented Aug 31, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sentry/sentry-docs/m2l7d8xpb/sentry.dev
✅ Preview: https://sentry-docs-git-feat-js-performance-docs.sentry.dev

Copy link
Contributor

@PeloWriter PeloWriter left a comment

Choose a reason for hiding this comment

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

Minor language smoothing.


- **[Performance](./performance/)**

Learn more about how to configure Performance for the JavaScript SDK. It provides examples of more advanced use cases.
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
Learn more about how to configure Performance for the JavaScript SDK. It provides examples of more advanced use cases.
Learn more about how to configure Performance for the JavaScript SDK, including examples of more advanced use cases.

### Manual Instrumentation

To manually instrument certain regions of your code, you can create a transaction to capture them.
This is valid for both JavaScript Browser and Node and works independently of the `BrowserTracing` integration.
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
This is valid for both JavaScript Browser and Node and works independently of the `BrowserTracing` integration.
This is valid for both the JavaScript Browser and Node SDKS, and works independently of the `BrowserTracing` integration.

transaction.finish(); // Finishing the transaction will send it to Sentry
```

Here is a different example. If you want to create a transaction for a user interaction on your page, you need to do the following:
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
Here is a different example. If you want to create a transaction for a user interaction on your page, you need to do the following:
This example creates a transaction for a user interaction on your page:

@rhcarvalho
Copy link
Contributor

@HazAT getsentry/sentry-javascript#2867 is merged, so this should be good to go now.

@HazAT HazAT closed this Sep 3, 2020
@HazAT HazAT deleted the feat/js-performance-docs branch September 3, 2020 14:48
@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
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