Fix issue62 : Support customized log directory and configuration properties directory

[linlinisme]

Does this pull request fix one issue?

Resolves #62

Describe how you did it

Split the configuration into two parts: the log and the sentinel-core. There are special tool classes to load the respective configurations. The tool class supports reading specified files, default files, and virtual machine parameter configurations.

the sentinel-core support configurations :

    public static final String APP_TYPE = "csp.sentinel.app.type";
    public static final String CHARSET = "csp.sentinel.charset";
    public static final String SINGLE_METRIC_FILE_SIZE = "csp.sentinel.metric.file.single.size";
    public static final String TOTAL_METRIC_FILE_COUNT = "csp.sentinel.metric.file.total.count";
    public static final String COLD_FACTOR = "csp.sentinel.flow.cold.factor";
    public static final String STATISTIC_MAX_RT = "csp.sentinel.statistic.max.rt";

Customize the loaded configuration file by configuring the csp.sentinel.config.file property.
for example -Dcsp.sentinel.config.file=sentinel.properties

the log:

    public static final String LOG_DIR = "csp.sentinel.log.dir";
    public static final String LOG_NAME_USE_PID = "csp.sentinel.log.use.pid";
    public static final String LOG_OUTPUT_TYPE = "csp.sentinel.log.output.type";
    public static final String LOG_CHARSET = "csp.sentinel.log.charset";

Customize the loaded configuration file by configuring the csp.sentinel.config.file property.
for example -Dcsp.sentinel.config.file=sentinel.properties

Pay attention! the log and sentinel-core configuration share a same config file now

Configure effective priority: virtual machine parameters -> -Dcsp.sentinel.config.file specifies file configuration

If -Dcsp.sentinel.config.file is not specified, the default value is sentinel.properties. That means you only need to add sentinel.properties to your project then you can load the custom configuration.

If you are the old version of the specified directory configuration: ${user.home}/logs/csp/appName.properties
And you want to keep the existing configuration path, it is also ok. You don't need to configure -Dcsp.sentinel.config.file nor need to add sentinel.properties to your project. Because it provides legacy compatibility.

Describe how to verify it

Configure the attribute value and run the project to see if it works.
And you can run the test cases in SentinelConfigTest、LogBaseTest、ConfigUtilTest

[codecov-io]

Codecov Report

Merging #804 into master will increase coverage by 0.36%.
The diff coverage is 72.79%.

@@             Coverage Diff              @@
##             master     #804      +/-   ##
============================================
+ Coverage     42.25%   42.62%   +0.36%     
- Complexity     1419     1439      +20     
============================================
  Files           307      310       +3     
  Lines          8894     8979      +85     
  Branches       1203     1218      +15     
============================================
+ Hits           3758     3827      +69     
- Misses         4677     4684       +7     
- Partials        459      468       +9

Impacted Files	Coverage Δ	Complexity Δ
...ava/com/alibaba/csp/sentinel/util/AppNameUtil.java	43.47% <ø> (ø)	5 <0> (ø)	⬇️
...om/alibaba/csp/sentinel/config/SentinelConfig.java	57.74% <100%> (+6.13%)	14 <3> (ø)	⬇️
...baba/csp/sentinel/config/SentinelConfigLoader.java	67.85% <67.85%> (ø)	4 <4> (?)
...ain/java/com/alibaba/csp/sentinel/log/LogBase.java	56.94% <69.56%> (-1.63%)	10 <4> (-1)
.../com/alibaba/csp/sentinel/log/LogConfigLoader.java	71.42% <71.42%> (ø)	4 <4> (?)
...java/com/alibaba/csp/sentinel/util/ConfigUtil.java	73.21% <73.21%> (ø)	12 <12> (?)
...ava/com/alibaba/csp/sentinel/node/ClusterNode.java	100% <0%> (+4.76%)	8% <0%> (+1%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c14e329...c71759f. Read the comment docs.

[vitrun]

when will this be fixed ? we can not use it in production if custom configuration is unavailable.

[sczyh30]

when will this be fixed ? we can not use it in production if custom configuration is unavailable.

@vitrun I'll take a review these days. It's expected to be included in 1.7.0 (perhaps in the next few weeks). If you're using Spring Boot/Spring Cloud you could leverage Spring Cloud Alibaba to support configuring via application.properties: https://github.com/spring-cloud-incubator/spring-cloud-alibaba/wiki/Sentinel#more

[linlinisme]

add test cases

[linlinisme]

feature support : retrieve properties from relative file.
now, there is three config ways:

1. absolute path
   -Dcsp.sentinel.config.file=/user/application/config/sentinel.properties
2. class path
   -Dcsp.sentinel.config.file=classpath:sentinel.properties
3. relative path
   -Dcsp.sentinel.config.file=config/sentinel.properties
   What need to be attention is the relative root path is the user.dir. For example if you start app in the /user/application dir and you config file is /user/application/config/sentinel.properties
   the correct config way is -Dcsp.sentinel.config.file=config/sentinel.properties

Dear @sczyh30 would you help me view the code?

[linlinisme]

friendly ping :)

[sczyh30]

friendly ping :)

I'll review these days :)

[sczyh30]

LGTM

[sczyh30]

Excellent, thanks for contributing!

Just one more thing to consider: it would be convenient if we could also support setting appName (project.name) in the properties file. This might entail discarding the legacy logic (~/logs/csp/${appName}.properties) and should be discussed later. See #239