Skip to content

Create structure for Performance content to be common across all platforms #2754

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

Merged
merged 6 commits into from
Dec 9, 2020

Conversation

PeloWriter
Copy link
Contributor

Note: This PR enables common content for JavaScript (and its guides) as well as React Native. A later PR will enable the common performance content for Go, Python, and PHP.

This is a WIP, the following includes (primarily appropriate code samples) need to be built for React Native:

  • Getting Started (index.mdx)

    • includes/performance/install-tracing-package
    • includes/performance/configure-tracing package
  • Grouping Transactions (group-transactions.mdx)

    • includes/performance/group-transaction-example
  • Manual Instrumentation (manual.mdx)

    • includes/performance/enable-manual-instrumentation
    • includes/performance/manual-instrumentation-example
  • Retrieve an Active Transaction (retrieve-active-transaction.mdx)

    • includes/performance/retrieve-transaction
  • Connecting Frontend and Backend Transactions

  • no include needed; this is unsupported by React Native at this time

  • Control Data Truncation (add-to-spans.mdx)

    • includes/performance/control-data-truncation
  • Automatic Instrumentation (automatic.mdx)

    • includes/performance/enable-automatic-instrumentation
    • includes/performance/tracingOrigins-example
    • includes/performance/beforeNavigate-example
    • includes/performance/filter-span-example

@PeloWriter PeloWriter requested a review from a team as a code owner December 8, 2020 01:38
@vercel
Copy link

vercel bot commented Dec 8, 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/itydko4ij/sentry.dev
✅ Preview: https://sentry-docs-git-update-make-performance-docs-common.sentry.dev

@bruno-garcia
Copy link
Member

@PeloWriter The snippets can be added in this PR, right? So @jennmueng could contribute here?

@PeloWriter
Copy link
Contributor Author

Yes, @bruno-garcia - adding here is fine.

@jennmueng
Copy link
Member

We want to get barebones docs for manual instrumentation out first as everything else is waiting on getsentry/sentry-react-native#1230.

Nothing needs to be installed as tracing is already included with the React Native SDK, the configuration would be a little different, and manual instrumentation works exactly the same on react native as on javascript, but maybe a React-component-specific example might be a good addition.

So if I understand this correctly I would just add react-native.mdx files in the includes folder? If that's right I'll get to work.

@PeloWriter
Copy link
Contributor Author

Yes, if you populate the directories noted with react-native.mdx files we'll be good to go.

@PeloWriter PeloWriter changed the title {WIP} Initial structure and include statements Create structure for Performance content can be common across all platforms Dec 9, 2020
@PeloWriter PeloWriter changed the title Create structure for Performance content can be common across all platforms Create structure for Performance content to be common across all platforms Dec 9, 2020
@PeloWriter PeloWriter merged commit 2e392c6 into master Dec 9, 2020
@PeloWriter PeloWriter deleted the update/make-performance-docs-common branch December 9, 2020 17:21
@github-actions github-actions bot locked and limited conversation to collaborators Dec 25, 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