Document manual session tracking

Open Beginner friendly
#1,461 7 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start by locating the existing session-tracking documentation and checking the issue's Python example against the documented API. Add guidance for manually wrapping a non-WSGI/ASGI session with Hub and auto_session_tracking; done means users can find and follow the example for their project type.

Written by the indexing model from the issue text.

Description

Docs good first issue Help Wanted Python
Problem Statement

If you have a non WSGI/ASGI project than there is no automatic session tracking.
But one can easily add session tracking by hand like this:

from sentry_sdk.hub import Hub
from sentry_sdk.sessions import auto_session_tracking

hub = Hub(Hub.current)
with auto_session_tracking(hub):
   # all the code that belong to one session goes here.
Solution Brainstorm

This should be somewhere in the documentation, so that people can add session tracking to their projects.

Dominant language
Python
Stars
2.2k
Forks
672
Avg merge
1d 13m
Merged PRs (30d)
212

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getsentry/sentry-python

All issues in getsentry/sentry-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.