You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@helix.apache.org by GitBox <gi...@apache.org> on 2020/08/08 04:20:00 UTC
[GitHub] [helix] pkuwm opened a new pull request #1237: Add error message of instance check to API response
pkuwm opened a new pull request #1237:
URL: https://github.com/apache/helix/pull/1237
### Issues
- [ ] My PR addresses the following Helix issues and references them in the PR description:
Fixed #1232
### Description
- [ ] Here are some details about my PR, including screenshots of any UI changes:
Health check stoppable responds with empty hostname.
This PR adds error message of instance check to API response:
```
curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : [ "HELIX:Instance stability check needs persist assignment cluster config turned on: PERSIST_INTERMEDIATE_ASSIGNMENT = true" ]
}
}
```
### Tests
- [ ] The following tests are written for this issue:
(List the names of added unit/integration tests)
- [ ] The following is the result of the "mvn test" command on the appropriate module:
(Before CI test pass, please copy & paste the result of "mvn test")
### Documentation (Optional)
- In case of new functionality, my PR adds documentation in the following wiki page:
(Link the GitHub wiki you added)
### Commits
- My commits all reference appropriate Apache Helix GitHub issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](http://chris.beams.io/posts/git-commit/)":
1. Subject is separated from body by a blank line
1. Subject is limited to 50 characters (not including Jira issue reference)
1. Subject does not end with a period
1. Subject uses the imperative mood ("add", not "adding")
1. Body wraps at 72 characters
1. Body explains "what" and "why", not "how"
### Code Quality
- My diff has been formatted using helix-style.xml
(helix-style-intellij.xml if IntelliJ IDE is used)
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm merged pull request #1237: Fix empty host list for instance stoppable response
Posted by GitBox <gi...@apache.org>.
pkuwm merged pull request #1237:
URL: https://github.com/apache/helix/pull/1237
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-671509536
> Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
@dasahcc This PR is to provide the info to let users know the reason. The root cause is exception/error is not returned as response. This PR adds the exception/error message to not stoppable reason in the return response.
https://github.com/apache/helix/pull/1237/files#diff-c98c0908866d29b64f625e799c198d15R224-R227
The result will be what is the description
```
curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : [ "HELIX:Instance stability check needs persist assignment cluster config turned on: PERSIST_INTERMEDIATE_ASSIGNMENT = true" ]
}
}
```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm edited a comment on pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm edited a comment on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-678613525
> Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
@dasahcc I think it is more appropriate to put this config check in `INVALID_CONFIG` health check, which is the first check in health status check. If configs are invalid, we don't need to do remaining checks like INSTANCE_NOT_STABLE.
The response should be like this
```
curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : [ "HELIX:INVALID_CONFIG" ]
}
}
```
I actually would like to add more info for users to know why. But with current implementation, it is not easy/straightforward to add the message. Maybe ` "HELIX:INVALID_CONFIG:Cluster config PERSIST_INTERMEDIATE_ASSIGNMENT is not turned on"
I think the better one would be a map response for each instance:
```
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : "hostname",
"health-check": [ "HELIX:INVALID_CONFIG" ],
"message": "Cluster config PERSIST_INTERMEDIATE_ASSIGNMENT is not turned on"
}
}
```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r475063343
##########
File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/InstanceServiceImpl.java
##########
@@ -213,7 +219,12 @@ public StoppableCheck getInstanceStoppableCheck(String clusterId, String instanc
instancesForNextCheck.add(instance);
}
} catch (InterruptedException | ExecutionException e) {
- LOG.error("Failed to get StoppableChecks in parallel. Instance: {}", instance, e);
+ LOG.warn("Failed to get StoppableChecks in parallel. Instance: {}. Caused by {}", instance,
Review comment:
I feel error is inappropriate for this kind of msg. It is not a server error.
ERROR should contain technical issues that need to be resolved for proper functioning of the system (ex: couldn’t connect to database)
WARN is best used for temporary problems or unexpected behavior that does not significantly hamper the functioning of the application (ex: failed user login)
INFO should contain messages that describe what is happening in the application (ex: user registered, order placed)
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1237: Fix empty host list for instance stoppable response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r476144914
##########
File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/InstanceServiceImpl.java
##########
@@ -213,7 +219,12 @@ public StoppableCheck getInstanceStoppableCheck(String clusterId, String instanc
instancesForNextCheck.add(instance);
}
} catch (InterruptedException | ExecutionException e) {
- LOG.error("Failed to get StoppableChecks in parallel. Instance: {}", instance, e);
+ LOG.warn("Failed to get StoppableChecks in parallel. Instance: {}. Caused by {}", instance,
Review comment:
The code change is not necessary and kept as it is.
Regarding warn or error, I look at it from server perspective: if the exception is not a server exception that affects running of the REST server, I would say it is an error.
But obviously this is not an exception that stops REST server running. It is just a normal running of the API check. It should not be logged as an error. A warning should already be enough to help debug.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] dasahcc removed a comment on pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
dasahcc removed a comment on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-671586099
> > Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
>
> @dasahcc This PR is to provide the info to let users know the reason. The root cause is exception/error is not returned as response. This PR adds the exception/error message to not stoppable reason in the return response.
> https://github.com/apache/helix/pull/1237/files#diff-c98c0908866d29b64f625e799c198d15R224-R227
>
> The result will be what is the description
>
> ```
> curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
> {
> "instance_stoppable_parallel" : [ ],
> "instance_not_stoppable_with_reasons" : {
> "instance" : [ "HELIX:Instance stability check needs persist assignment cluster config turned on: PERSIST_INTERMEDIATE_ASSIGNMENT = true" ]
> }
> }
> ```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] dasahcc closed pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
dasahcc closed pull request #1237:
URL: https://github.com/apache/helix/pull/1237
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] jiajunwang commented on a change in pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
jiajunwang commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r472446728
##########
File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/InstanceServiceImpl.java
##########
@@ -213,7 +219,12 @@ public StoppableCheck getInstanceStoppableCheck(String clusterId, String instanc
instancesForNextCheck.add(instance);
}
} catch (InterruptedException | ExecutionException e) {
- LOG.error("Failed to get StoppableChecks in parallel. Instance: {}", instance, e);
+ LOG.warn("Failed to get StoppableChecks in parallel. Instance: {}. Caused by {}", instance,
Review comment:
Why it is a warning now?
##########
File path: helix-core/src/main/java/org/apache/helix/util/InstanceValidationUtil.java
##########
@@ -261,7 +261,9 @@ public static boolean isInstanceStable(HelixDataAccessor dataAccessor, String in
throw new HelixException("Missing cluster config!");
}
if (!clusterConfig.isPersistIntermediateAssignment()) {
- throw new HelixException("isInstanceStable needs persist assignment on!");
+ throw new HelixException(String.format(
+ "Instance stability check needs persist assignment cluster config turned on: %s = true",
Review comment:
I find this may be misleading. Can we change it to, "Persist assignment (%s) is not turned on in the Cluster Config. This is required to enable instance stability check."
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm edited a comment on pull request #1237: Add config check to instance stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm edited a comment on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-678613525
> Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
@dasahcc I think it is more appropriate to put this config check in `INVALID_CONFIG` health check, which is the first check in health status check. If configs are invalid, we don't need to do remaining checks like INSTANCE_NOT_STABLE.
The response should be like this
```
curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : [ "HELIX:INVALID_CONFIG" ]
}
}
```
I actually would like to add more info for users to know why. But with current implementation, it is not easy/straightforward to add the message. Maybe ` "HELIX:INVALID_CONFIG:Cluster config PERSIST_INTERMEDIATE_ASSIGNMENT is not turned on"
I think the better one would be a map response for each instance:
```
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : [{
"instance" : "hostname",
"health-check": [ "HELIX:INVALID_CONFIG" ],
"message": "Cluster config PERSIST_INTERMEDIATE_ASSIGNMENT is not turned on"
}]
}
```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on pull request #1237: Fix empty host list for instance stoppable response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-683107165
Thanks, @dasahcc @jiajunwang, for the review.
This PR is ready to be merged, approved by @dasahcc
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r475063102
##########
File path: helix-core/src/main/java/org/apache/helix/util/InstanceValidationUtil.java
##########
@@ -261,7 +261,9 @@ public static boolean isInstanceStable(HelixDataAccessor dataAccessor, String in
throw new HelixException("Missing cluster config!");
}
if (!clusterConfig.isPersistIntermediateAssignment()) {
- throw new HelixException("isInstanceStable needs persist assignment on!");
+ throw new HelixException(String.format(
+ "Instance stability check needs persist assignment cluster config turned on: %s = true",
Review comment:
Made it clearer.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] jiajunwang commented on a change in pull request #1237: Fix empty host list for instance stoppable response
Posted by GitBox <gi...@apache.org>.
jiajunwang commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r475811851
##########
File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/InstanceServiceImpl.java
##########
@@ -213,7 +219,12 @@ public StoppableCheck getInstanceStoppableCheck(String clusterId, String instanc
instancesForNextCheck.add(instance);
}
} catch (InterruptedException | ExecutionException e) {
- LOG.error("Failed to get StoppableChecks in parallel. Instance: {}", instance, e);
+ LOG.warn("Failed to get StoppableChecks in parallel. Instance: {}. Caused by {}", instance,
Review comment:
I think the failure reason does not really matter here (although an Exception looks to be a problem to me more than a warning).
The real matter thing is that whether the result is complete and fully computed. If not certain, then this is an error.
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] dasahcc commented on pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
dasahcc commented on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-671586099
> > Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
>
> @dasahcc This PR is to provide the info to let users know the reason. The root cause is exception/error is not returned as response. This PR adds the exception/error message to not stoppable reason in the return response.
> https://github.com/apache/helix/pull/1237/files#diff-c98c0908866d29b64f625e799c198d15R224-R227
>
> The result will be what is the description
>
> ```
> curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
> {
> "instance_stoppable_parallel" : [ ],
> "instance_not_stoppable_with_reasons" : {
> "instance" : [ "HELIX:Instance stability check needs persist assignment cluster config turned on: PERSIST_INTERMEDIATE_ASSIGNMENT = true" ]
> }
> }
> ```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on a change in pull request #1237: Add config check to instance stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on a change in pull request #1237:
URL: https://github.com/apache/helix/pull/1237#discussion_r475067511
##########
File path: helix-rest/src/main/java/org/apache/helix/rest/server/service/InstanceService.java
##########
@@ -72,9 +72,10 @@
/**
* Pre-defined list of checks to test if an instance is in healthy running state
*/
- public static List<HealthCheck> STARTED_AND_HEALTH_CHECK_LIST =
- ImmutableList.of(HealthCheck.INSTANCE_NOT_ALIVE, HealthCheck.INSTANCE_NOT_ENABLED,
- HealthCheck.INSTANCE_NOT_STABLE, HealthCheck.EMPTY_RESOURCE_ASSIGNMENT);
+ public static List<HealthCheck> STARTED_AND_HEALTH_CHECK_LIST = ImmutableList
+ .of(HealthCheck.INVALID_CONFIG, HealthCheck.INSTANCE_NOT_ALIVE,
Review comment:
@dasahcc `INVALID_CONFIG` should also be added to STARTED_AND_HEALTH_CHECK_LIST, right?
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org
[GitHub] [helix] pkuwm commented on pull request #1237: Add error message of instance check to stoppable API response
Posted by GitBox <gi...@apache.org>.
pkuwm commented on pull request #1237:
URL: https://github.com/apache/helix/pull/1237#issuecomment-678613525
> Error message for server side is clear to find out the fail reason. The more important is let user to understand what is the real fail reason. Do we have that if persist assignment turned off, at least, we gave user info EV and IS does not match.
@dasahcc I think it is more appropriate to put this config check in `INVALID_CONFIG` health check, which is the first check in health status check. If configs are invalid, we don't need to do remaining checks like INSTANCE_NOT_STABLE.
The response should be like this
```
curl -XPOST http://localhost:8100/admin/v2/namespaces/namespacce/clusters/cluster/instances\?command\=stoppable -d ' {"instances": ["instance"], "selection_base": "zone_based", "max_instance": "2", "customized_values": "{}"}' -H "Content-Type: application/json"
{
"instance_stoppable_parallel" : [ ],
"instance_not_stoppable_with_reasons" : {
"instance" : [ "HELIX:INVALID_CONFIG" ]
}
}
```
----------------------------------------------------------------
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
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org
For additional commands, e-mail: reviews-help@helix.apache.org