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.

Sign up for GitHub

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

Jump to bottom

feat(sessions): only recognize session id on root span (where parent is null) #5351

Merged
merged 1 commit into from
Nov 13, 2024
Merged

feat(sessions): only recognize session id on root span (where parent is null) #5351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
59 changes: 30 additions & 29 deletions src/phoenix/db/insertion/span.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,36 +37,37 @@ async def insert_span(
assert project_rowid is not None

project_session: Optional[models.ProjectSession] = None
session_id = get_attribute_value(span.attributes, SpanAttributes.SESSION_ID)
session_user = get_attribute_value(span.attributes, SpanAttributes.USER_ID)
if session_id is not None and (not isinstance(session_id, str) or session_id.strip()):
session_id = str(session_id).strip()
assert isinstance(session_id, str)
if session_user is not None:
session_user = str(session_user).strip()
assert isinstance(session_user, str)
project_session = await session.scalar(
select(models.ProjectSession).filter_by(session_id=session_id)
)
if project_session:
if project_session.end_time < span.end_time:
project_session.end_time = span.end_time
project_session.project_id = project_rowid
if span.start_time < project_session.start_time:
project_session.start_time = span.start_time
if session_user and project_session.session_user != session_user:
project_session.session_user = session_user
else:
project_session = models.ProjectSession(
project_id=project_rowid,
session_id=session_id,
session_user=session_user if session_user else None,
start_time=span.start_time,
end_time=span.end_time,
if span.parent_id is None:
session_id = get_attribute_value(span.attributes, SpanAttributes.SESSION_ID)
session_user = get_attribute_value(span.attributes, SpanAttributes.USER_ID)
if session_id is not None and (not isinstance(session_id, str) or session_id.strip()):
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
if session_id is not None and (not isinstance(session_id, str) or session_id.strip()):
if session_id is not None:

Is the second part of the conditional necessary?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

technically it's possible to have "" (empty string) as the session.id, do we want to record that?

Copy link
Contributor

Choose a reason for hiding this comment

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

I see. Probably not would be my guess.

session_id = str(session_id).strip()
assert isinstance(session_id, str)
if session_user is not None:
session_user = str(session_user).strip()
assert isinstance(session_user, str)
project_session = await session.scalar(
select(models.ProjectSession).filter_by(session_id=session_id)
)
session.add(project_session)
if project_session in session.dirty:
await session.flush()
if project_session:
if project_session.end_time < span.end_time:
project_session.end_time = span.end_time
axiomofjoy marked this conversation as resolved.
Show resolved Hide resolved
project_session.project_id = project_rowid
if span.start_time < project_session.start_time:
project_session.start_time = span.start_time
if session_user and project_session.session_user != session_user:
project_session.session_user = session_user
else:
project_session = models.ProjectSession(
project_id=project_rowid,
session_id=session_id,
session_user=session_user if session_user else None,
start_time=span.start_time,
end_time=span.end_time,
)
session.add(project_session)
if project_session in session.dirty:
await session.flush()

trace_id = span.context.trace_id
trace = await session.scalar(select(models.Trace).filter_by(trace_id=trace_id))
Expand Down
11 changes: 5 additions & 6 deletions tests/integration/project_sessions/test_project_sessions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,16 @@ def test_span_ingestion_with_session_id(
assert num_traces > 1 and num_spans_per_trace > 2
project_names = [token_hex(8)]
spans: List[Span] = []
wrong_session_id = token_hex(32)
for _ in range(num_traces):
project_names.append(token_hex(8))
with ExitStack() as stack:
for i in range(num_spans_per_trace):
if i == 0:
# Not all spans are required to have `session_id`.
attributes = None
elif i == 1:
# In case of conflict, the `Span` with later `end_time` wins.
attributes = {SpanAttributes.SESSION_ID: session_id}
elif str_session_id:
attributes = {SpanAttributes.SESSION_ID: token_hex(8)}
else:
# Session ID on non-root spans will be ignored.
attributes = {SpanAttributes.SESSION_ID: wrong_session_id}
span = _start_span(
project_name=project_names[-1],
exporter=_grpc_span_exporter(),
Expand Down Expand Up @@ -84,6 +82,7 @@ def test_span_ingestion_with_session_id(
assert not sessions_by_id
return
assert sessions_by_id
assert wrong_session_id not in sessions_by_id
assert (session := sessions_by_id.get(str_session_id))
assert (traces := [edge["node"] for edge in session["node"]["traces"]["edges"]])
assert len(traces) == num_traces
Expand Down
Loading