Skip to content

QueryTraceMetrics: add handler and update rest store#19448

Merged
serena-ruan merged 3 commits intotrace-metricsfrom
add_handler
Dec 18, 2025
Merged

QueryTraceMetrics: add handler and update rest store#19448
serena-ruan merged 3 commits intotrace-metricsfrom
add_handler

Conversation

@serena-ruan
Copy link
Collaborator

@serena-ruan serena-ruan commented Dec 17, 2025

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

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

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Add handler for QueryTraceMetrics and update rest_store for handling it.

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)

@github-actions github-actions bot added the rn/none List under Small Changes in Changelogs. label Dec 17, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 17, 2025

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

Copy link
Member

@harupy harupy left a comment

Choose a reason for hiding this comment

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

LGTM

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 querying trace metrics through a new QueryTraceMetrics API endpoint. The implementation includes REST API handler, store method, and entity serialization/deserialization support.

  • Adds query_trace_metrics method to RestStore for executing trace metrics queries
  • Implements _query_trace_metrics handler to process API requests with validation
  • Extends entity classes with from_proto and to_proto methods for MetricViewType, MetricAggregation, and MetricDataPoint

Reviewed changes

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

Show a summary per file
File Description
mlflow/entities/trace_metrics.py Adds bidirectional proto conversion methods: from_proto() for MetricViewType and MetricAggregation, and to_proto() for MetricDataPoint
mlflow/store/tracking/rest_store.py Implements query_trace_metrics() method that constructs requests, calls the endpoint, and returns paginated results
mlflow/server/handlers.py Adds _query_trace_metrics() handler with request validation schema and response construction, registers it in HANDLERS dict
tests/entities/test_trace_metrics.py Adds test coverage for new proto conversion methods
tests/store/tracking/test_rest_store.py Tests REST store query method including endpoint calls and response parsing
tests/server/test_handlers.py Tests handler with both populated and empty results, including pagination
tests/tracking/test_rest_tracking.py Integration test that creates traces and queries metrics with aggregations

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

Signed-off-by: Serena Ruan <serena.rxy@gmail.com>
Signed-off-by: Serena Ruan <serena.rxy@gmail.com>
Signed-off-by: Serena Ruan <serena.rxy@gmail.com>
@serena-ruan serena-ruan merged commit 7020b20 into trace-metrics Dec 18, 2025
47 checks passed
@serena-ruan serena-ruan deleted the add_handler branch December 18, 2025 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants