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

SDK documentation for Performance Monitoring #240

Merged
merged 1 commit into from
Jan 18, 2021

Conversation

bruno-garcia
Copy link
Member

In this PR we want to address some of the points of this issue #221

Goals:

  • Better general guidelines for SDK developers to implement performance monitoring support
  • FAQ section at the end with common questions that come up
  • Links to source code of different SDKs to demonstrate how it was done so far
  • Clearly communicate some differences (EventProcessor is called in JS but not in others SDKs necessarily).

@vercel
Copy link

vercel bot commented Jan 13, 2021

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/develop/bjucfbkn8/sentry.dev
✅ Preview: https://develop-git-ref-sdk-performance.sentry.dev

@bruno-garcia bruno-garcia marked this pull request as draft January 13, 2021 17:32
@bruno-garcia bruno-garcia marked this pull request as ready for review January 17, 2021 00:23
Copy link
Contributor

@rhcarvalho rhcarvalho left a comment

Choose a reason for hiding this comment

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

The redirects don't seem to be working in the preview deployment, but otherwise nothing is broken so feel free to merge and iterate on it later.

@bruno-garcia we could update https://github.com/getsentry/develop/blob/master/src/docs/sdk/index.mdx to make the Perf Mon page part of the "home page" for SDK docs, makes it easier to navigate to it.

@@ -1,8 +1,8 @@
---
title: "Guidelines for Tracing Support"
title: "Guidelines for Performance Monitoring"
Copy link
Contributor

Choose a reason for hiding this comment

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

Idea: if one of the problems is this page is hard to find, try adding tags: [...] here in the frontmatter, I heard it is picked up by Algolia search.

Copy link
Member Author

Choose a reason for hiding this comment

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

OK merged, but lets follow up on this an iterate

@bruno-garcia bruno-garcia merged commit cd7a434 into master Jan 18, 2021
Mobile Platform Team Archived automation moved this from In Progress to Done Jan 18, 2021
@bruno-garcia bruno-garcia deleted the ref/sdk-performance branch January 18, 2021 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

2 participants