You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2020/07/19 21:21:55 UTC
[GitHub] [pulsar] srkukarni opened a new pull request #7601: Add readiness api for the worker leader
srkukarni opened a new pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601
<!--
### Contribution Checklist
- Name the pull request in the form "[Issue XYZ][component] Title of the pull request", where *XYZ* should be replaced by the actual issue number.
Skip *Issue XYZ* if there is no associated github issue for this pull request.
Skip *component* if you are unsure about which is the best component. E.g. `[docs] Fix typo in produce method`.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
**(The sections below can be removed for hotfixes of typos)**
-->
*(If this PR fixes a github issue, please add `Fixes #<xyz>`.)*
Fixes #<xyz>
*(or if this PR is one task of a github issue, please add `Master Issue: #<xyz>` to link to the master issue.)*
Master Issue: #<xyz>
### Motivation
This mr adds an api to check if the worker is ready to serve requests.
### Modifications
*Describe the modifications you've done.*
### Verifying this change
- [ ] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
*If `yes` was chosen, please highlight the changes*
- Dependencies (does it add or upgrade a dependency): (yes / no)
- The public API: (yes / no)
- The schema: (yes / no / don't know)
- The default values of configurations: (yes / no)
- The wire protocol: (yes / no)
- The rest endpoints: (yes / no)
- The admin cli options: (yes / no)
- Anything that affects deployment: (yes / no / don't know)
### Documentation
- Does this pull request introduce a new feature? (yes / no)
- If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)
- If a feature is not applicable for documentation, explain why?
- If a feature is not documented yet in this PR, please create a followup issue for adding the documentation
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-663053522
/pulsarbot run-failure-checks
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng closed pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng closed pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457570328
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leaderready")
Review comment:
I think the url path would be more clean if it is /cluster/leader/ready. We can add more API under "/leader" in future
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661243191
So this endpoint is authentication protected? Is that what we want?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457589151
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leaderready")
Review comment:
Changed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] merlimat merged pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
merlimat merged pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457591308
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leader/ready")
+ @Produces(MediaType.APPLICATION_JSON)
+ public String isLeaderReady() {
Review comment:
Something like
https://github.com/apache/pulsar/blob/master/pulsar-functions/worker/src/main/java/org/apache/pulsar/functions/worker/rest/WorkerReadinessResource.java#L65
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661221544
@srkukarni what is the purpose of add this new REST endpoint?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661240682
@jerrypeng the current usecase is for setting up testing pipelines.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457597805
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leader/ready")
+ @Produces(MediaType.APPLICATION_JSON)
+ public String isLeaderReady() {
Review comment:
Changed
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-663169192
/pulsarbot run-failure-checks
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng edited a comment on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng edited a comment on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661243191
So this endpoint is authentication protected, is that what we want?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] srkukarni commented on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
srkukarni commented on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661523720
/pulsarbot run-failure-checks
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457590322
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leader/ready")
+ @Produces(MediaType.APPLICATION_JSON)
+ public String isLeaderReady() {
Review comment:
I think it is more appropriate to just return 200 for OK or 503 (service not available). That is more idiomatic for HTTP REST calls
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng commented on a change in pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng commented on a change in pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#discussion_r457570720
##########
File path: pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/v2/Worker.java
##########
@@ -129,4 +129,19 @@ public WorkerInfo getClusterLeader() {
public void rebalance() {
worker.rebalance(uri.getRequestUri(), clientAppId());
}
+
+ @GET
+ @ApiOperation(
+ value = "Checks if this node is the leader and is ready to service requests",
+ response = String.class
+ )
+ @ApiResponses(value = {
+ @ApiResponse(code = 401, message = "The requester is not authenticated"),
+ @ApiResponse(code = 503, message = "Worker service is not running")
+ })
+ @Path("/cluster/leaderready")
Review comment:
Beside we already have have the url path "/cluster/leader"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] jerrypeng edited a comment on pull request #7601: Add readiness api for the worker leader
Posted by GitBox <gi...@apache.org>.
jerrypeng edited a comment on pull request #7601:
URL: https://github.com/apache/pulsar/pull/7601#issuecomment-661221544
@srkukarni what is the purpose of adding this new REST endpoint?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org