Proxy readiness and make logs messages consistent #146
Conversation
This file contains 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
Allow setting an endpoint path for the function readiness check via an ENV variable `function_ready_endpoint` When this value is set, the requests to `/_/ready` will execute an empty GET request with/to the configured endpoint. This allows the function authors to implement custom readiness check logic. This custom request is checked _after_ the the standard liviness checks and the ConcurrencyLimiter check. For a completely custom readiness check, the function should be deployed with `max_inflight == 0` and `function_ready_endpoint` to the custom path. Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
When proxying the readiness request to the upstream function, we should copy the original request headers. This allows the handler to use headers, if needed. It also allows the of-watchdog to suppress the noisy request logging for readiness checks. Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
User read_path instead of function_ready_endpoint. This should be clearer that it needs to be a path on the function and match prior art in other projects. Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com>
Document why we use the base function handler to provide custom ready checks to all function modes. Additionally, make sure that the unwrapped function handler is passed to the readiness check. This ensures that readiness checks do not count toward the concurrency limit Review by AE - reverts change to faas-middleware, by introducing an interface. Closes: #145 Signed-off-by: Lucas Roesler <roesler.lucas@gmail.com> Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
Makes the response messages consistent between HTTP, streaming and serializing modes. Tested with various processes as a Go process on a Linux host. Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
|
Based on the description, this sounds like it may also close #144. |
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.
Description
Proxy readiness and make logs messages consistent
Motivation and Context
Closes #145 - removing the need for additional methods in the faas-middleware package, and fixing an underlying bug in the way the readiness endpoint was called in one of the handlers. These other handlers also printed out log messages when using the readiness proxying, so that's been changed, so that it only happens when the User-Agent is not from Kubernetes.
Also: Makes the response messages consistent between HTTP, streaming and serializing modes.
How Has This Been Tested?
Tested with various processes as a Go process on a Linux host.
Including the unit testing added by Lucas in the reviewed PR.
Types of changes
The log format is changed, if users are relying on parsing this, they can stay on an older version until they can migrate.
However all OF templates use either classic-watchdog or HTTP mode.