Add a configurable /v1/events-test route #9
Merged
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
If `test_events` is configured, a `GET /v1/events-test` route will be added. When requested, the `test_events` will be produced as if they were POSTed to /v1/events. This is useful for readiness probes that want to make sure the service can produce events end to end. Bug: T251935
Pchelolo
reviewed
Aug 5, 2020
README.md
Outdated
| @@ -231,6 +231,12 @@ services: | |||
| # ... | |||
| ``` | |||
|
|
|||
| # /v1/events-test route | |||
| If you are using EventGate as a service, and if `test_events` is configured, | |||
| a `GET /v1/events-test` route will be added. When requested, the `test_events` will be produced as if | |||
There was a problem hiding this comment.
- Should it be a POST route requiring no body? having GET produce things doesn't seem safe...
- should it be prefixed with
_since it's an internal thingy? or, even not prefixed withv1but something else? like_internal/v1/ - should it maybe be called in a more generic way? like
/_internal/v1/probe?
There was a problem hiding this comment.
- Has to be GET, I want to use this with a k8s readinessProbe which does not support POST.
- & 3. Hm. not sure. Let's discuss in IRC.
There was a problem hiding this comment.
Going with /v1/_test/events
More clearly indicates that this is a route for internal use.
Pchelolo
approved these changes
Aug 5, 2020
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.
No description provided.