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

[mlobs] improve docs for user session tracking #25955

Merged
merged 4 commits into from
Oct 29, 2024
Merged

[mlobs] improve docs for user session tracking #25955

merged 4 commits into from
Oct 29, 2024

Conversation

lievan
Copy link
Contributor

@lievan lievan commented Oct 28, 2024 •
edited
Loading

What does this PR do? What is the motivation?

We don't mention user_* tags for our session tracking feature, we should document those as well

  • add a table of session tracking tabs
  • update code example to include user tags

Merge instructions

Merge queue is enabled in this repo. To have it automatically merged after it receives the required reviews, create the PR (from a branch that follows the <yourname>/description naming convention) and then add the following PR comment:

/merge

Additional notes

@lievan lievan added the Do Not Merge Just do not merge this PR :) label Oct 28, 2024
@github-actions GitHub Actions
Copy link
Contributor

Preview links (active after the build_preview check completes)

Modified Files

@lievan lievan marked this pull request as ready for review October 28, 2024 22:45
@lievan lievan requested a review from a team as a code owner October 28, 2024 22:45
@lievan lievan removed the Do Not Merge Just do not merge this PR :) label Oct 28, 2024
@lievan lievan requested review from Yun-Kim and aholachek October 28, 2024 22:46
maycmlee
maycmlee reviewed Oct 29, 2024
View reviewed changes
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

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

Just some small suggestions.

content/en/llm_observability/setup/sdk/_index.md Outdated Show resolved Hide resolved
content/en/llm_observability/setup/sdk/_index.md Outdated Show resolved Hide resolved
aholachek
aholachek approved these changes Oct 29, 2024
View reviewed changes
Copy link
Contributor

@aholachek aholachek 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 adding this

content/en/llm_observability/setup/sdk/_index.md Outdated
| Tag | Description |
|---|---|
| `session_id` | ID representing a single user session, e.g. a chat session |
| `user_handle` | The handle for the user of the chat session |
Copy link
Contributor

Choose a reason for hiding this comment

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

I added support for both user_handle and user_name since they are both datadog concepts but honestly they are repetitive -- we really need to think through this data and also how it ties into RUM sessions. But for now this is good

@lievan
Copy link
Contributor Author

lievan commented Oct 29, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Oct 29, 2024

🚂 MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.

Use /merge -c to cancel this operation!

@dd-devflow
Copy link

dd-devflow bot commented Oct 29, 2024

🚂 MergeQueue: pull request added to the queue

The median merge time in master is 25m.

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit 1ac0c10 into master Oct 29, 2024
20 of 24 checks passed
@dd-mergequeue dd-mergequeue bot deleted the evan.li/improve-session-tracking-docs branch October 29, 2024 15:08
theraffoul pushed a commit that referenced this pull request Nov 25, 2024
@lievan @theraffoul
[mlobs] improve docs for user session tracking (#25955)
a4e2357 
Co-authored-by:  <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@maycmlee maycmlee maycmlee approved these changes

@aholachek aholachek aholachek approved these changes

@Yun-Kim Yun-Kim Awaiting requested review from Yun-Kim

Assignees
No one assigned
Labels
mergequeue-status: done
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lievan @aholachek @maycmlee