[close #397] add git commit hash and version info while TiSession create #408
Conversation
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
| logger.info("Release Version: " + properties.getProperty("git.build.version")); | ||
| logger.info("Git Commit Hash: " + properties.getProperty("git.commit.id.full")); | ||
| } catch (Exception e) { | ||
| logger.error("Fail to read package info: " + e.getMessage()); |
There was a problem hiding this comment.
I think it's better to set it to info level since users don't need to perform any operation after seeing this log.
| logger.info("Release Version: " + properties.getProperty("git.build.version")); | ||
| logger.info("Git Commit Hash: " + properties.getProperty("git.commit.id.full")); |
There was a problem hiding this comment.
it's better to aggregate them into one log item to:
- reduce the log items and the total log size.
- reduce the log search (i.e.
grep) burden
| printVersionInfo(); | ||
| } | ||
|
|
||
| private void printVersionInfo() { |
There was a problem hiding this comment.
how about refactoring this function to:
private void getVersionInfo() String {
}then log the info in TiSession and add a UT for this function.
There was a problem hiding this comment.
It's hard to write suck UT to assert the commit hash.
There was a problem hiding this comment.
Now, I capture these logic into VersionInfo, PTAL.
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
| String commitHash = properties.getProperty("git.commit.id.full"); | ||
| info = new VersionInfo(version, commitHash); | ||
| } catch (Exception e) { | ||
| logger.info("Fail to read package info: " + e.getMessage()); |
There was a problem hiding this comment.
| logger.info("Fail to read package info: " + e.getMessage()); | |
| logger.error("Fail to read package info: " + e.getMessage()); |
There was a problem hiding this comment.
conflicted with: #408 (comment). Personally speaking, I think the error log level could help us discover some building issues.
| @@ -103,6 +120,22 @@ public TiSession(TiConfiguration conf) { | |||
| warmUp(); | |||
| this.circuitBreaker = new CircuitBreakerImpl(conf); | |||
| logger.info("TiSession initialized in " + conf.getKvMode() + " mode"); | |||
| logger.info("Welcome to TiKV Java Client {}", getVersionInfo()); | |||
There was a problem hiding this comment.
It would print a welcome message when every new TiSession is created. Considering that an application can use multiple TiSessions, is there a better place to print this message?
Signed-off-by: iosmanthus <myosmanthustree@gmail.com>
|
/merge |
|
/run-all-tests |
zz-jason
changed the title
Signed-off-by: iosmanthus myosmanthustree@gmail.com
What problem does this PR solve?
Add info logs while
TisessioncreateIssue Number: close #397
Problem Description: TBD
What is changed and how it works?
Check List for Tests
This PR has been tested by at least one of the following methods:
Related changes