Skip to content

[UI Telemetry] Allow session_id and installation_id to be overridden in TelemetryRecord#19240

Merged
daniellok-db merged 1 commit intomlflow:masterfrom
daniellok-db:stack/update-telemetry-config
Dec 15, 2025
Merged

[UI Telemetry] Allow session_id and installation_id to be overridden in TelemetryRecord#19240
daniellok-db merged 1 commit intomlflow:masterfrom
daniellok-db:stack/update-telemetry-config

Conversation

@daniellok-db
Copy link
Collaborator

@daniellok-db daniellok-db commented Dec 5, 2025 •
edited
Loading

🥞 Stacked PR

Use this link to review incremental changes.

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

This PR adds some optional fields to the telemetry Record dataclass. This is because with UI telemetry, we plan to reuse the existing telemetry client. However, the session_id and installation_id fields need to come from the browser, not from the python client. The UI will send these as part of the POST request payload, so we need to make sure they are respected.

How is this PR tested?

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

Manually tested end-to-end and made sure they show up correctly in the final table.

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)

Copilot AI review requested due to automatic review settings December 5, 2025 09:15
@github-actions
Copy link
Contributor

github-actions bot commented Dec 5, 2025

@daniellok-db Thank you for the contribution! Could you fix the following issue(s)?

⚠ DCO check

The DCO check failed. Please sign off your commit(s) by following the instructions here. See https://github.com/mlflow/mlflow/blob/master/CONTRIBUTING.md#sign-your-work for more details.

Copilot AI reviewed Dec 5, 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 overriding session_id and installation_id in telemetry records, allowing callers to provide custom values instead of using the defaults from the telemetry client.

  • Added optional installation_id and session_id fields to the Record dataclass
  • Modified Record.to_dict() to conditionally include these fields when specified
  • Added comprehensive test coverage for both override and default behavior scenarios

Reviewed changes

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

File Description
mlflow/telemetry/schemas.py Added optional installation_id and session_id fields to Record class with conditional inclusion in to_dict() method to support overriding client defaults
tests/telemetry/test_client.py Added test test_record_with_session_and_installation_id to verify that records can override client's session/installation IDs and fall back to client defaults when not specified

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

@github-actions
Copy link
Contributor

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

Documentation preview for e086ee2 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.

@daniellok-db daniellok-db changed the title edit schema [UI Telemetry] Edit schema Dec 5, 2025
@daniellok-db daniellok-db changed the title [UI Telemetry] Edit schema [UI Telemetry] Allow session_id and installation_id to be overridden in TelemetryRecord Dec 5, 2025
@github-actions github-actions bot added area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs. labels Dec 5, 2025
serena-ruan
serena-ruan approved these changes Dec 9, 2025
View reviewed changes
Copy link
Collaborator

@serena-ruan serena-ruan left a comment

Choose a reason for hiding this comment

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

LGTM!

@daniellok-db daniellok-db force-pushed the stack/update-telemetry-config branch from 69b68c2 to 7307230 Compare December 9, 2025 07:55
This was referenced Dec 9, 2025
Merged
Merged
Closed
This was referenced Dec 9, 2025
Merged
Merged
Merged
@daniellok-db daniellok-db force-pushed the stack/update-telemetry-config branch from 7307230 to e086ee2 Compare December 12, 2025 06:56
@daniellok-db
Copy link
Collaborator Author

daniellok-db commented Dec 15, 2025

merging, test failure looks like flake since non-windows passed 🤔, plus this change is unrelated to tracing

@daniellok-db daniellok-db merged commit 705bf27 into mlflow:master Dec 15, 2025
57 of 60 checks passed
WeichenXu123 pushed a commit to WeichenXu123/mlflow that referenced this pull request Dec 19, 2025
@daniellok-db @WeichenXu123
[UI Telemetry] Allow session_id and installation_id to be overridden …
d1e2c3d 
…in TelemetryRecord (mlflow#19240)
WeichenXu123 pushed a commit that referenced this pull request Dec 19, 2025
@daniellok-db @WeichenXu123
[UI Telemetry] Allow session_id and installation_id to be overridden …
2f23493 
…in TelemetryRecord (#19240)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@serena-ruan serena-ruan serena-ruan approved these changes

@B-Step62 B-Step62 Awaiting requested review from B-Step62

Assignees

@serena-ruan serena-ruan

Labels

area/build Build and test infrastructure for MLflow rn/none List under Small Changes in Changelogs. v3.8.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@daniellok-db @serena-ruan