Skip to content

Add endpoint tags#19308

Merged
BenWilson2 merged 8 commits intomlflow:masterfrom
BenWilson2:secrets-tags
Dec 12, 2025
Merged

Add endpoint tags#19308
BenWilson2 merged 8 commits intomlflow:masterfrom
BenWilson2:secrets-tags

Conversation

@BenWilson2
Copy link
Member

@BenWilson2 BenWilson2 commented Dec 10, 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/19308/merge
# mlflow-skinny
pip install git+https://github.com/mlflow/mlflow.git@refs/pull/19308/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/19308/merge

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add Gateway Endpoint tags support (guard against potential disambiguation for now, needed eventually for AI Gateway).

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)

Copilot AI review requested due to automatic review settings December 10, 2025 01:00
@github-actions github-actions bot added area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. labels Dec 10, 2025
Copilot AI reviewed Dec 10, 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 pull request adds tag support for Gateway Endpoints, enabling key-value pair metadata to be associated with endpoints for categorization and filtering purposes. The PR also includes a comprehensive refactoring to rename endpoint-related methods from *_endpoint to *_gateway_endpoint for consistency.

Key changes:

  • Introduces a new GatewayEndpointTag entity and database table for storing endpoint tags
  • Adds set_gateway_endpoint_tag and delete_gateway_endpoint_tag methods across all store implementations
  • Renames all endpoint-related methods to include "gateway_" prefix for API consistency
  • Implements comprehensive test coverage for tag operations including cascading deletes

Reviewed changes

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

Show a summary per file
File Description
mlflow/store/db_migrations/versions/1bd49d398cd23_add_secrets_tables.py Adds endpoint_tags table with foreign key constraints and cascading deletes
mlflow/store/tracking/dbmodels/models.py Implements SqlGatewayEndpointTag model with relationship to SqlGatewayEndpoint
mlflow/entities/gateway_endpoint.py Adds GatewayEndpointTag entity class and integrates tags into GatewayEndpoint
mlflow/entities/__init__.py Exports the new GatewayEndpointTag class
mlflow/protos/service.proto Defines protobuf messages for tag operations and updates RPC method names
mlflow/protos/service_pb2.pyi Updates type stubs for new tag-related messages
mlflow/store/tracking/gateway/abstract_mixin.py Adds abstract methods for tag operations and renames endpoint methods
mlflow/store/tracking/gateway/sqlalchemy_mixin.py Implements tag storage logic using SQLAlchemy with merge/delete operations
mlflow/store/tracking/gateway/rest_mixin.py Implements REST API client for tag operations
mlflow/server/handlers.py Adds HTTP handlers for tag set/delete and updates endpoint method names
tests/tracking/test_rest_tracking.py Adds integration tests for tag operations via REST API
tests/store/tracking/test_gateway_sql_store.py Adds comprehensive unit tests for tag storage including edge cases
docs/api_reference/api_inventory.txt Updates API documentation inventory with new tag-related methods

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

@github-actions
Copy link
Contributor

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

Documentation preview for 8236350 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 added the team-review Trigger a team review request label Dec 10, 2025
@BenWilson2
Add endpoint tags
c637a9e 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
add api listing
0ac20c5 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
rename
02c4bb9 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
fix
fb2dda8 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
fix db files
eeb7548 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
Merge branch 'master' into secrets-tags
a9f9213 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
TomeHirata
TomeHirata reviewed Dec 11, 2025
View reviewed changes
mlflow/store/db_migrations/versions/1bd49d398cd23_add_secrets_tables.py
from alembic import op

# revision identifiers, used by Alembic.
revision = "1b49d398cd23"
Copy link
Collaborator

@TomeHirata TomeHirata Dec 11, 2025

Choose a reason for hiding this comment

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

Oh, so was the revision id incorrect?

Copy link
Member Author

@BenWilson2 BenWilson2 Dec 11, 2025

Choose a reason for hiding this comment

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

Some weird typo when I was editing... I probably didn't realize and hit delete while the cursor was on that line.

TomeHirata
TomeHirata reviewed Dec 11, 2025
View reviewed changes
mlflow/store/db_migrations/versions/1bd49d398cd23_add_secrets_tables.py
),
)

op.create_table(
Copy link
Collaborator

@TomeHirata TomeHirata Dec 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

What happens for people who already have revision '1bd49d398cd23' in the database? Do they need to rollback and migrate again? I'm wondering if we should separate a migration file or not in this case.

Copy link
Member Author

@BenWilson2 BenWilson2 Dec 11, 2025

Choose a reason for hiding this comment

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

Still safe to edit since we haven't released this yet :)

TomeHirata
TomeHirata approved these changes Dec 11, 2025
View reviewed changes
Copy link
Collaborator

@TomeHirata TomeHirata left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, can you take a look at my comment on the migration file?

@BenWilson2
Merge branch 'master' into secrets-tags
c930b4d 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2
fix
8236350 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
@BenWilson2 BenWilson2 added this pull request to the merge queue Dec 12, 2025
Merged via the queue into mlflow:master with commit 2b0bf23 Dec 12, 2025
54 checks passed
@BenWilson2 BenWilson2 deleted the secrets-tags branch December 12, 2025 00:31
debu-sinha pushed a commit to debu-sinha/mlflow that referenced this pull request Dec 12, 2025
@BenWilson2
Add endpoint tags (mlflow#19308)
db3dd4a 
Signed-off-by: Ben Wilson <benjamin.wilson@databricks.com>
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

@TomeHirata TomeHirata TomeHirata approved these changes

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

@daniellok-db daniellok-db Awaiting requested review from daniellok-db

@harupy harupy Awaiting requested review from harupy

@kevin-lyn kevin-lyn Awaiting requested review from kevin-lyn

@serena-ruan serena-ruan Awaiting requested review from serena-ruan

@WeichenXu123 WeichenXu123 Awaiting requested review from WeichenXu123

@xq-yin xq-yin Awaiting requested review from xq-yin

Assignees

@TomeHirata TomeHirata

Labels

area/tracking Tracking service, tracking client APIs, autologging rn/feature Mention under Features in Changelogs. team-review Trigger a team review request

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@BenWilson2 @TomeHirata