Skip to content

Adds static prefix to both health and version routes.#13314

Merged
BenWilson2 merged 2 commits intomlflow:masterfrom
alokshenoy:static-prefix-healthcheck
Dec 3, 2025
Merged

Adds static prefix to both health and version routes.#13314
BenWilson2 merged 2 commits intomlflow:masterfrom
alokshenoy:static-prefix-healthcheck

Conversation

@alokshenoy
Copy link
Contributor

@alokshenoy alokshenoy commented Oct 3, 2024 •
edited
Loading

🛠 DevTools 🛠

Open in GitHub Codespaces

Install mlflow from this PR

pip install git+https://github.com/mlflow/mlflow.git@refs/pull/13314/merge

Checkout with GitHub CLI

gh pr checkout 13314

Related Issues/PRs

Looks like there is a open FR that covers part of the changes implemented in this PR.

Resolve #13199

What changes are proposed in this pull request?

Adds the static prefix to the health and version routes.

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/artifacts: Artifact stores and artifact logging
  • area/build: Build and test infrastructure for MLflow
  • area/deployments: MLflow Deployments client APIs, server, and third-party Deployments integrations
  • area/docs: MLflow documentation pages
  • area/examples: Example code
  • area/model-registry: Model Registry service, APIs, and the fluent client calls for Model Registry
  • area/models: MLmodel format, model serialization/deserialization, flavors
  • area/recipes: Recipes, Recipe APIs, Recipe configs, Recipe Templates
  • area/projects: MLproject format, project running backends
  • area/scoring: MLflow Model server, model deployment tools, Spark UDFs
  • area/server-infra: MLflow Tracking server backend
  • area/tracking: Tracking Service, tracking client APIs, autologging

Interface

  • area/uiux: Front-end, user experience, plotting, JavaScript, JavaScript dev server
  • area/docker: Docker use across MLflow's components, such as MLflow Projects and MLflow Models
  • area/sqlalchemy: Use of SQLAlchemy in the Tracking Service or Model Registry
  • area/windows: Windows support

Language

  • language/r: R APIs and clients
  • language/java: Java APIs and clients
  • language/new: Proposals for new client languages

Integrations

  • integrations/azure: Azure and Azure ML integrations
  • integrations/sagemaker: SageMaker integrations
  • integrations/databricks: Databricks integrations

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
Copy link
Contributor

github-actions bot commented Oct 3, 2024

@alokshenoy 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.

@github-actions github-actions bot added patch-2.17.0 rn/none List under Small Changes in Changelogs. labels Oct 3, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 3, 2024 •
edited
Loading

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

@alokshenoy alokshenoy force-pushed the static-prefix-healthcheck branch 2 times, most recently from fd10d4c to ef7e634 Compare October 3, 2024 13:30
@alokshenoy
Adds static prefix to both health and version routes.
c5249f9 
Signed-off-by: Alok Shenoy <contact@alokshenoy.me>
@alokshenoy alokshenoy force-pushed the static-prefix-healthcheck branch from ef7e634 to c5249f9 Compare October 3, 2024 13:32
harupy
harupy approved these changes Oct 8, 2024
View reviewed changes
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.

Looks good to me :)

@alokshenoy
Copy link
Contributor Author

alokshenoy commented Oct 8, 2024

@harupy - I think I should also update the response from the API call so that the links returned include the static_prefixes. Or create a separate ticket for it.
image

@DimitriM
Copy link

DimitriM commented Mar 17, 2025 •
edited
Loading

The static prefix should also be added to the auth unprotected routes since they are fixed now:
https://github.com/mlflow/mlflow/blob/master/mlflow/server/auth/__init__.py

def is_unprotected_route(path: str) -> bool:
    return path.startswith(("/static", "/favicon.ico", "/health"))

@KyleHaugen
Copy link

KyleHaugen commented Aug 7, 2025

Hello, I am experiencing this issue with adding a static_prefix in a containerized environment which renders the health endpoint unusable. This fix looks perfect and the PR has been approved. Is it possible to get this merged?

@alokshenoy
Copy link
Contributor Author

alokshenoy commented Aug 7, 2025

Not sure why it didn't get included in one of the previous releases 🤷🏼

@alokshenoy
Copy link
Contributor Author

alokshenoy commented Nov 30, 2025

@harupy - what can we do to get this merged in the upcoming release?

@BenWilson2 BenWilson2 added this pull request to the merge queue Dec 3, 2025
Merged via the queue into mlflow:master with commit 370d9ad Dec 3, 2025
46 checks passed
BenWilson2 pushed a commit to BenWilson2/mlflow that referenced this pull request Dec 4, 2025
@alokshenoy @BenWilson2
Adds static prefix to both health and version routes. (mlflow#13314)
ae185f9 
Signed-off-by: Alok Shenoy <contact@alokshenoy.me>
BenWilson2 pushed a commit that referenced this pull request Dec 4, 2025
@alokshenoy @BenWilson2
Adds static prefix to both health and version routes. (#13314)
9a11fd4 
Signed-off-by: Alok Shenoy <contact@alokshenoy.me>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@harupy harupy harupy approved these changes

Assignees

No one assigned

Labels

rn/none List under Small Changes in Changelogs. v3.7.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[FR] static-prefix health endpoint

5 participants

@alokshenoy @DimitriM @KyleHaugen @harupy @BenWilson2