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

Support HTTP Head Method for /healthz endpoint. #8144

Closed
2 tasks done
rahulmistri1997 opened this issue Feb 12, 2024 · 4 comments · Fixed by #8145
Closed
2 tasks done

Support HTTP Head Method for /healthz endpoint. #8144

rahulmistri1997 opened this issue Feb 12, 2024 · 4 comments · Fixed by #8145
Labels
type:enhancement Requests for feature enhancements or new features

Comments

@rahulmistri1997
Copy link
Contributor

Checklist

  • I have searched the existing issues for similar feature requests.
  • I added a descriptive title and summary to this issue.

Summary

Implementing support for the HTTP HEAD method for the /healthz endpoint enhances efficiency and reduces bandwidth usage by allowing quick retrieval of metadata about the service's health without sending the entire response body.
This aligns with HTTP standards, improves monitoring capabilities, and contributes to the scalability and reliability of the system.

Why?

I wanted to add support for the HTTP HEAD method to the /healthz endpoint because I wanted to integrate it with my monitoring service, which only supports HEAD requests. Upon further consideration, I realized the benefits it offers. Specifically, it enhances efficiency by allowing quick retrieval of metadata about the service's health without transmitting the entire response body, reducing bandwidth usage. Additionally, supporting this method aligns with HTTP standards, improves monitoring capabilities, and contributes to the scalability and reliability of the system.

How?

Adding support for the HEAD method in the following router Class.

class HealthHandler(_SpecialRequestHandler):

Additional Context

No response

@rahulmistri1997 rahulmistri1997 added the type:enhancement Requests for feature enhancements or new features label Feb 12, 2024
Copy link

To help Streamlit prioritize this feature, react with a 👍 (thumbs up emoji) to the initial post.

Your vote helps us identify which enhancements matter most to our users.

Visits

@rahulmistri1997
Copy link
Contributor Author

I have made changes to my self-hosted fork and am now ready to open a pull request.

I'm interested in volunteering.

@vdonato
Copy link
Collaborator

vdonato commented Feb 13, 2024

Implemented by #8145! Our release for this month already happened on the first of the month, so this change should land in 1.32.0 on March 7.

It'll also be available starting tonight in the nightly build for those that want to use it earlier.

@rahulmistri1997
Copy link
Contributor Author

Awesome,
Looking forward to it 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:enhancement Requests for feature enhancements or new features
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants