Add telemetry to gateway start#19479
Merged
TomeHirata merged 8 commits intomlflow:masterfrom Dec 18, 2025
Merged
Conversation
- Introduced `GatewayStartEvent` to track the start of the MLflow Gateway service. - Applied the `record_usage_event` decorator to the `start` command in the CLI. - Added a test to validate telemetry recording for the Gateway start event. Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds telemetry tracking to the mlflow gateway start CLI command to collect anonymous usage data about gateway service starts. The implementation follows the established telemetry pattern used for other CLI commands like mlflow mcp run.
- Introduces a new
GatewayStartEventfor tracking gateway service starts - Adds the
@record_usage_eventdecorator to thestartCLI command - Includes comprehensive test coverage following existing test patterns
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mlflow/telemetry/events.py | Defines the new GatewayStartEvent class for tracking gateway start events |
| mlflow/gateway/cli.py | Applies the @record_usage_event decorator to the start command and adds necessary imports |
| tests/telemetry/test_tracked_events.py | Adds test coverage for the gateway start event tracking, including import of the new event class |
| docs/docs/community/usage-tracking.mdx | Documents the new gateway_start event in the usage tracking documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
|
Documentation preview for 2c238f3 is available at: Changed Pages (1)
More info
|
serena-ruan
reviewed
Dec 18, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com>
Contributor
|
Please use |
WeichenXu123
pushed a commit
to WeichenXu123/mlflow
that referenced
this pull request
Dec 19, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com> Signed-off-by: TomuHirata <tomu.hirata@gmail.com>
WeichenXu123
pushed a commit
that referenced
this pull request
Dec 19, 2025
Signed-off-by: Tomu Hirata <tomu.hirata@gmail.com> Signed-off-by: TomuHirata <tomu.hirata@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🛠 DevTools 🛠
Install mlflow from this PR
For Databricks, use the following command:
Related Issues/PRs
n/a
What changes are proposed in this pull request?
Add usage tracking to
mlflow gateway startCLIHow is this PR tested?
Does this PR require documentation update?
Release Notes
Is this a user-facing change?
What component(s), interfaces, languages, and integrations does this PR affect?
Components
area/tracking: Tracking Service, tracking client APIs, autologgingarea/models: MLmodel format, model serialization/deserialization, flavorsarea/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registryarea/scoring: MLflow Model server, model deployment tools, Spark UDFsarea/evaluation: MLflow model evaluation features, evaluation metrics, and evaluation workflowsarea/gateway: MLflow AI Gateway client APIs, server, and third-party integrationsarea/prompts: MLflow prompt engineering features, prompt templates, and prompt managementarea/tracing: MLflow Tracing features, tracing APIs, and LLM tracing functionalityarea/projects: MLproject format, project running backendsarea/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev serverarea/build: Build and test infrastructure for MLflowarea/docs: MLflow documentation pagesHow 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" sectionrn/breaking-change- The PR will be mentioned in the "Breaking Changes" sectionrn/feature- A new user-facing feature worth mentioning in the release notesrn/bug-fix- A user-facing bug fix worth mentioning in the release notesrn/documentation- A user-facing documentation change worth mentioning in the release notesShould this PR be included in the next patch release?
Yesshould be selected for bug fixes, documentation updates, and other small changes.Noshould 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?
Bug fixes, doc updates and new features usually go into minor releases.
Bug fixes and doc updates usually go into patch releases.