Skip to content

Support session ID set by OpenTelemetry semantic convention#19211

Merged
serena-ruan merged 2 commits intomlflow:masterfrom
serena-ruan:session_attribute_translation
Dec 5, 2025
Merged

Support session ID set by OpenTelemetry semantic convention#19211
serena-ruan merged 2 commits intomlflow:masterfrom
serena-ruan:session_attribute_translation

Conversation

@serena-ruan
Copy link
Collaborator

@serena-ruan serena-ruan commented Dec 4, 2025 •
edited by github-actions bot
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19211/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19211/merge#subdirectory=libs/skinny

For Databricks, use the following command:

%sh curl -LsSf https://raw.githubusercontent.com/mlflow/mlflow/HEAD/dev/install-skinny.sh | sh -s pull/19211/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Support translation OTel session ID to mlflow's session ID so that it can render on UI correctly:
image
image
image

How is this PR tested?

  • Existing unit/integration tests
  • New unit/integration tests
  • Manual tests

Does this PR require documentation update?

  • No. You can skip the rest of this section.
  • Yes. I've updated:
    • Examples
    • API references
    • Instructions

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release notes for MLflow users.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/tracking: Tracking Service, tracking client APIs, autologging
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflows
  • area/gateway: MLflow AI Gateway client APIs, server, and third-party integrations
  • area/prompts: MLflow prompt engineering features, prompt templates, and prompt management
  • area/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionality
  • area/projects: MLproject format, project running backends
  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/build: Build and test infrastructure for MLflow
  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section
  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • rn/feature - A new user-facing feature worth mentioning in the release notes
  • rn/bug-fix - A user-facing bug fix worth mentioning in the release notes
  • rn/documentation - A user-facing documentation change worth mentioning in the release notes

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)

@serena-ruan
session id translation
4d2ba37 
Signed-off-by: Serena Ruan <serena.rxy@gmail.com>
Copilot AI review requested due to automatic review settings December 4, 2025 11:27
@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Dec 4, 2025
Copilot AI reviewed Dec 4, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds support for translating OpenTelemetry semantic convention session IDs (session.id) to MLflow's session IDs, enabling proper rendering in the MLflow UI. The implementation extracts session IDs from span attributes and stores them in trace metadata, with logic to preserve existing session IDs.

Key Changes

  • Session ID extraction from OTel span attributes during span logging
  • Session ID storage in trace metadata with preservation of existing values
  • Test coverage for session ID handling including creation, preservation, and absence scenarios

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
mlflow/store/tracking/sqlalchemy_store.py Adds logic to extract session.id from span attributes and store it in trace metadata, only setting a new session ID if one doesn't already exist
tests/store/tracking/test_sqlalchemy_store.py Adds comprehensive test cases for session ID handling including storage from attributes, preservation of existing session IDs, and behavior when no session ID is present

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025 •
edited
Loading

Documentation preview for e2dc19d is available at:

More info
  • Ignore this comment if this PR does not change the documentation.
  • The preview is updated when a new commit is pushed to this PR.
  • This comment was created by this workflow run.
  • The documentation was built by this workflow run.

BenWilson2
BenWilson2 approved these changes Dec 4, 2025
View reviewed changes
Copy link
Member

@BenWilson2 BenWilson2 left a comment

Choose a reason for hiding this comment

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

Looks good. I don't think we need to have guards for span processing with broken session configurations within a root span (like Copilot recommended)

@serena-ruan
update
e2dc19d 
Signed-off-by: Serena Ruan <serena.rxy@gmail.com>
TomeHirata
TomeHirata reviewed Dec 5, 2025
View reviewed changes
mlflow/store/tracking/sqlalchemy_store.py
aggregated_token_usage = update_token_usage(
aggregated_token_usage, span_token_usage
)
# session id used by OTel semantic conventions: https://opentelemetry.io/docs/specs/semconv/registry/attributes/session/#session-id
Copy link
Collaborator

@TomeHirata TomeHirata Dec 5, 2025

Choose a reason for hiding this comment

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

Shall we define this key in mlflow/tracing/constant.py?

Copy link
Collaborator Author

@serena-ruan serena-ruan Dec 5, 2025

Choose a reason for hiding this comment

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

We can, but I think that file is more for constants reused in mlflow tracing concepts, and this is only used here once

@serena-ruan serena-ruan merged commit 7b6a708 into mlflow:master Dec 5, 2025
47 of 49 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@TomeHirata TomeHirata TomeHirata left review comments

Copilot code review Copilot Copilot left review comments

@BenWilson2 BenWilson2 BenWilson2 approved these changes

Assignees

No one assigned

Labels

rn/none List under Small Changes in Changelogs.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@serena-ruan @TomeHirata @BenWilson2