Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments by TomeHirata · Pull Request #21149 · mlflow/mlflow

TomeHirata · 2026-02-26T05:21:00Z

Related Issues/PRs

n/a

What changes are proposed in this pull request?

Currently mlflow doesn't return null value when negative filter is used for experiment tags. And because of it, we cannot exclude gateway experiments with sourceType tag since most experiments don't have this tag.

How is this PR tested?

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

Does this PR require documentation update?

Does this PR require updating the MLflow Skills repository?

No. You can skip the rest of this section.
Yes. Please link the corresponding PR or explain how you plan to update it.

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

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)

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

github-actions · 2026-02-26T05:21:12Z

🛠 DevTools 🛠

Install mlflow from this PR

# mlflow
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/21149/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/21149/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/21149/merge

Copilot

Pull request overview

Adds a new experiment tag to identify experiments created for MLflow AI Gateway usage tracking, enabling downstream consumers (UI/filters/analytics) to reliably detect “gateway experiments”.

Changes:

Introduce MLFLOW_EXPERIMENT_IS_GATEWAY = "mlflow.experiment.isGateway" in the shared tags module.
Set mlflow.experiment.isGateway = "true" when the gateway store auto-creates an experiment during endpoint create/update.
Extend the existing SQL store test to assert the new tag on auto-created experiments.

Reviewed changes

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

File	Description
`mlflow/utils/mlflow_tags.py`	Adds a constant for the new experiment tag key.
`mlflow/store/tracking/gateway/sqlalchemy_mixin.py`	Applies the new tag during gateway experiment auto-creation in create/update flows.
`tests/store/tracking/test_gateway_sql_store.py`	Verifies the new tag is present on an auto-created experiment.

mlflow/store/tracking/gateway/sqlalchemy_mixin.py

Copilot · 2026-02-26T05:25:02Z

mlflow/store/tracking/gateway/sqlalchemy_mixin.py

                    tags=[
                        ExperimentTag(MLFLOW_EXPERIMENT_SOURCE_TYPE, "GATEWAY"),
                        ExperimentTag(MLFLOW_EXPERIMENT_SOURCE_ID, endpoint_id),
+                        ExperimentTag(MLFLOW_EXPERIMENT_IS_GATEWAY, "true"),
                    ],


🟡 MODERATE: This PR adds the mlflow.experiment.isGateway tag when update_gateway_endpoint() auto-creates an experiment, but there’s no test exercising the update flow where usage_tracking is enabled and an experiment is created implicitly. Adding a unit/integration test for that scenario would prevent regressions and verify the new tag (and existing sourceType/sourceId) are set correctly.

github-actions · 2026-02-26T05:31:05Z

Documentation preview for 07b8419 is available at:

https://pr-21149--mlflow-docs-preview.netlify.app/docs/latest/

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.

harupy · 2026-02-26T06:12:45Z

@TomeHirata Can you update the PR description and explain why we need to add this?

harupy

LGTM once #21149 (comment) is addressed!

serena-ruan

LGTM!

WeichenXu123

LGTM.

harupy · 2026-02-26T07:26:10Z

@WeichenXu123 No need to add another stamp to a PR that’s already been approved.

…1149) Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments

07b8419

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

Copilot AI review requested due to automatic review settings February 26, 2026 05:21

github-actions bot added the size/S Small PR (10-49 LoC) label Feb 26, 2026

github-actions bot added the v3.10.1 label Feb 26, 2026

TomeHirata requested review from B-Step62, harupy and serena-ruan February 26, 2026 05:21

github-actions bot added the rn/none List under Small Changes in Changelogs. label Feb 26, 2026

Copilot started reviewing on behalf of TomeHirata February 26, 2026 05:21 View session

TomeHirata mentioned this pull request Feb 26, 2026

Move gateway experiment filtering to server-side query to fix inconsistent page sizes #21138

Merged

9 tasks

Copilot AI reviewed Feb 26, 2026

View reviewed changes

github-actions bot assigned harupy Feb 26, 2026

harupy approved these changes Feb 26, 2026

View reviewed changes

serena-ruan approved these changes Feb 26, 2026

View reviewed changes

WeichenXu123 approved these changes Feb 26, 2026

View reviewed changes

TomeHirata added this pull request to the merge queue Feb 26, 2026

Merged via the queue into mlflow:master with commit 7d491a6 Feb 26, 2026
67 of 70 checks passed

TomeHirata deleted the gateway/experiment-tag branch February 26, 2026 07:54

daniellok-db pushed a commit to daniellok-db/mlflow that referenced this pull request Mar 5, 2026

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments (mlflow#2…

3606441

…1149) Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

daniellok-db pushed a commit to daniellok-db/mlflow that referenced this pull request Mar 5, 2026

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments (mlflow#2…

7219906

…1149) Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

daniellok-db pushed a commit that referenced this pull request Mar 5, 2026

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments (#21149)

948c491

Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments#21149

Add MLFLOW_EXPERIMENT_IS_GATEWAY tag to gateway experiments#21149
TomeHirata merged 1 commit intomlflow:masterfrom
TomeHirata:gateway/experiment-tag

TomeHirata commented Feb 26, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 26, 2026

Install mlflow from this PR

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI Feb 26, 2026

Uh oh!

github-actions bot commented Feb 26, 2026

Uh oh!

harupy commented Feb 26, 2026 •

edited

Loading

Uh oh!

harupy left a comment

Uh oh!

serena-ruan left a comment

Uh oh!

WeichenXu123 left a comment

Uh oh!

harupy commented Feb 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

TomeHirata commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Related Issues/PRs

What changes are proposed in this pull request?

How is this PR tested?

Does this PR require documentation update?

Does this PR require updating the MLflow Skills repository?

Release Notes

Is this a user-facing change?

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

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

Should this PR be included in the next patch release?

Uh oh!

github-actions bot commented Feb 26, 2026

Install mlflow from this PR

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI Feb 26, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 26, 2026

Uh oh!

harupy commented Feb 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

harupy left a comment

Choose a reason for hiding this comment

Uh oh!

serena-ruan left a comment

Choose a reason for hiding this comment

Uh oh!

WeichenXu123 left a comment

Choose a reason for hiding this comment

Uh oh!

harupy commented Feb 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

TomeHirata commented Feb 26, 2026 •

edited

Loading

harupy commented Feb 26, 2026 •

edited

Loading