Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add /health endpoint #2725

Merged
merged 3 commits into from Apr 17, 2020
Merged

Add /health endpoint #2725

merged 3 commits into from Apr 17, 2020

Conversation

crflynn
Copy link
Contributor

@crflynn crflynn commented Apr 17, 2020

What changes are proposed in this pull request?

Adds a healthcheck endpoint at /health for checking application liveness.

How is this patch tested?

There is a test against the flask app test client to ensure that the endpoint returns a 200 response status code.

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.

Adds a healthcheck endpoint to the REST API server at /health that always returns a 200 response status code, to be used to verify health of the server.

What component(s) does this PR affect?

  • UI
  • CLI
  • API
  • REST-API
  • Examples
  • Docs
  • Tracking
  • Projects
  • Artifacts
  • Models
  • Model Registry
  • Scoring
  • Serving
  • R
  • Java
  • Python

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

  • rn/breaking-change - The PR will be mentioned in the "Breaking Changes" section
  • 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/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

@aarondav aarondav changed the title Add healthcheck endpoint Add /health endpoint Apr 17, 2020
@aarondav
Copy link
Contributor

LGTM, thanks for adding the test!

@aarondav aarondav merged commit 8531fb3 into mlflow:master Apr 17, 2020
@aarondav aarondav mentioned this pull request Apr 17, 2020
22 tasks
@smurching smurching added the rn/feature Mention under Features in Changelogs. label Apr 20, 2020
arjundc-db added a commit that referenced this pull request Apr 20, 2020
* Refactor tests: split out sagemaker, tensorflow, and other model flavors from python large (#2710)

* Use pytest.ini to specify `--color=yes` (#2716)

* Change plotly to use scattergl (#2447)

* Add /health endpoint (#2725)

* Update note about MacOS compatibility (#2392)

* Make MlflowClient serializable (#2723)

Make the Java MlflowClient class implement Serializable so that it can be used in Spark jobs

* Fix autologging of Keras optimizers for TF.Keras 1.X (#2709)

Merged.

* Added model registry to index.rst; concepts.rst; aligned some languag… (#2582)

* Add mlflow.note.content to tags and documentation (#2726)

* Use LibYAML by default to increase performance in FileUtils (#2707)

* FileUtils: Try to use LibYAML by default to increase performance. By default PyYAML is using Python parser, which is significantly slower than its C++ counter-part.

* Fix slack invite link (#2733)

* Fix slack link

* Use rst syntax

* Preparing for release 1.8.0 (#2718)

* Project import generated by Copybara.

GitOrigin-RevId: f290c7d549fbb82a50f8760113d5144bb4a997ff

* Lint fix in ModelView.js

* Removing Tabs

* Fixing imports

* Fixing version numbers in react-dom

* Project import generated by Copybara.

GitOrigin-RevId: 36896445fc4b32d17da255c21f545b527dec92a3

* Style fixes

Co-authored-by: Richard Zang <Zangr@users.noreply.github.com>
Co-authored-by: Sid Murching <sid.murching@databricks.com>

Co-authored-by: Mani Parkhe <mani@databricks.com>
Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com>
Co-authored-by: Michael Lingelbach <m.j.lbach@gmail.com>
Co-authored-by: Flynn <crflynn@users.noreply.github.com>
Co-authored-by: Jeffrey McLarty <jnmclarty@users.noreply.github.com>
Co-authored-by: juntai-zheng <39497939+juntai-zheng@users.noreply.github.com>
Co-authored-by: dmatrix <dmatrix@comcast.net>
Co-authored-by: Vojtech Micka <micka.vojtech@gmail.com>
Co-authored-by: Arjun DCunha <61438563+arjundc-db@users.noreply.github.com>
Co-authored-by: Richard Zang <Zangr@users.noreply.github.com>
@mjmikulski
Copy link

What about health check in Python client (e.g. mlflow.check_remote_server())? Are there any plans to implement it?

avflor pushed a commit to avflor/mlflow that referenced this pull request Aug 22, 2020
@VMannello
Copy link

It appears this isn't working when serving a model using mlflow models serve when using version 1.20.2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
rn/feature Mention under Features in Changelogs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants