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

feat(develop-docs): SDK Debug Mode #12100

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

philipphofmann
Copy link
Member

@philipphofmann philipphofmann commented Dec 12, 2024

DESCRIBE YOUR PR

Add docs for the SDK debug mode. Explain that SDKs can choose the default log level themselves.

Not all SDKs have the diagnostics level. Currently, most mobile SDKs have it; see https://github.com/search?q=repo%3Agetsentry%2Fsentry-docs+diagnostic-level&type=code. Also, the usage of debug logs varies across SDKs. Therefore, I wrote this so that every SDK can choose what they prefer.

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

Add docs for the SDK debug mode. Explain that SDKs can choose the
default log level themselves.
Copy link

vercel bot commented Dec 12, 2024

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

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 13, 2024 10:03am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Dec 13, 2024 10:03am
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Dec 13, 2024 10:03am

@philipphofmann philipphofmann marked this pull request as ready for review December 13, 2024 09:56
@philipphofmann philipphofmann requested a review from a team December 13, 2024 09:56
Copy link
Member

@kahest kahest left a comment

Choose a reason for hiding this comment

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

thanks for writing this down 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Needs Review
Development

Successfully merging this pull request may close these issues.

2 participants