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(logs): intial work on develop docs for sdk logging api #12920

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

Conversation

AbhiPrasad
Copy link
Member

@AbhiPrasad AbhiPrasad commented Mar 4, 2025

resolves #12870

Sentry is exploring an application logging product! More details here in our internal notion: https://www.notion.so/sentry/PRFAQ-Application-Logging-1258b10e4b5d80ea8e98e8ec5505542c.

To get the ball rolling, I'm helping push forward the spec in the SDK. This was initially in Notion (https://www.notion.so/sentry/Logs-in-the-SDK-1a48b10e4b5d80b1827fe14d9fd0236b#1a58b10e4b5d80019d2eef6d84213d4a), but now we're moving it to develop so that we can work more in the open.

This PR documents:

  1. The idealized public api for logs
  2. The idealized sdk options for logs
  3. The otel log envelope format
  4. The recommended internal sdk behavior for logs

You'll notice only the otel_log envelope item is documented. This is what we used for the first alpha release of the SDK, but we'll be moving the SDKs to use the log envelope item instead. Until the logenvelope item protocol is finalized we are avoiding documenting in develop, but we marked it as TODO in the necessary sections.

@AbhiPrasad AbhiPrasad self-assigned this Mar 4, 2025
Copy link

vercel bot commented Mar 4, 2025

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 Mar 6, 2025 3:19pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Mar 6, 2025 3:19pm
sentry-docs ⬜️ Ignored (Inspect) Visit Preview Mar 6, 2025 3:19pm

@AbhiPrasad AbhiPrasad changed the title [WIP] feat(logs): intial work on develop docs for sdk logging api feat(logs): intial work on develop docs for sdk logging api Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add Logs Section to Develop Docs
3 participants