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 2022/08/31 20:39:56 UTC

[GitHub] [helix] Marcosrico opened a new pull request, #2201: Downgraded Deletion Error Logs to Avoid Error Spam Logging

Marcosrico opened a new pull request, #2201:
URL: https://github.com/apache/helix/pull/2201

Downgraded error logs from `ZkClient` delete and `ZkBaseDataAcessor` remove methods to reduce logging noise for trivial errors.

### Issues

- [X] My PR addresses the following Helix issues and references them in the PR description:

https://jira01.corp.linkedin.com:8443/browse/HELIX-4375

(#200 - Link your issue number here: You can write "Fixes #XXX". Please use the proper keyword so that the issue gets closed automatically. See https://docs.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue
Any of the following keywords can be used: close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved)

### Description

- [X] Here are some details about my PR, including screenshots of any UI changes:

Downgraded failed remove log in `ZkBaseDataAcessor` from `Log.debug` to `Log.info`. This log error shows when there is an attempt to delete a parent ZNode with non-empty children. However, it automatically calls another function that recursively deletes the children of the node and in the case this operation is successful, having a stack-trace error from before can confuse users of a problem that is in fact trivial. The same was done in the deletion method itself from `ZkClient`. By downgrading to info, users may still see the error logs but it will minimize the amount of noise cause by these warnings.

There has been an attempt to avoid calling delete in `ZkClient` altogether and just call `deleteRecursively` dependent on the number of children of the node. However, there were no solution thought of that would avoid race conditions and/or extra overhead from calling `getChildren()` multiple times.

### Tests

- [X] The following tests are written for this issue:

Added `testDeleteLogging()` in `TestZkBaseDataAccessor.java`

The test creates a 10 instance message records. It proceeds to call remove on the parent of those children. The test checks whether remove returns true, which it does. However, the purpose of it is to check whether the logs are shown. Going through the debugger, the logs are outputted.

- The following is the result of the "mvn test" command on the appropriate module:

(If CI test fails due to known issue, please specify the issue and test PR locally. Then copy & paste the result of "mvn test" to here.)

### Changes that Break Backward Compatibility (Optional)

- My PR contains changes that break backward compatibility or previous assumptions for certain methods or API. They include:

(Consider including all behavior changes for public methods or API. Also include these changes in merge description so that other developers are aware of these changes. This allows them to make relevant code changes in feature branches accounting for the new method/API behavior.)

### 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.

To unsubscribe, e-mail: reviews-unsubscribe@helix.apache.org

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