Skip to content

Commit

Permalink
Support setting project.name via the properties file and deprecate le…
Browse files Browse the repository at this point in the history 
…gacy config path (alibaba#1412)
  • Loading branch information
@linlinisme
linlinisme authored Apr 26, 2020
1 parent 27953d6 commit 744f3d6
Show file tree
Hide file tree
Showing 5 changed files with 71 additions and 87 deletions.
63 changes: 61 additions & 2 deletions sentinel-core/src/main/java/com/alibaba/csp/sentinel/config/SentinelConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@
package com.alibaba.csp.sentinel.config;

import com.alibaba.csp.sentinel.log.RecordLog;
import com.alibaba.csp.sentinel.util.AppNameUtil;
import com.alibaba.csp.sentinel.util.AssertUtil;
import com.alibaba.csp.sentinel.util.StringUtil;

import java.io.File;
import java.util.Map;
import java.util.Properties;
import java.util.concurrent.ConcurrentHashMap;
Expand All @@ -30,6 +30,7 @@
*
* @author leyou
* @author Eric Zhao
* @author Lin Liang
*/
public final class SentinelConfig {

Expand All @@ -56,6 +57,12 @@ public final class SentinelConfig {
static final int DEFAULT_TOTAL_METRIC_FILE_COUNT = 6;
static final int DEFAULT_COLD_FACTOR = 3;

private static String appName = "";
public static final String APP_NAME = "project.name";
public static final String SUN_JAVA_COMMAND = "sun.java.command";
private static final String JAR_SUFFIX_LOWER = ".jar";
private static final String JAR_SUFFIX_UPPER = ".JAR";

public static final int DEFAULT_STATISTIC_MAX_RT = 4900;

static {
Expand All @@ -64,6 +71,8 @@ public final class SentinelConfig {
loadProps();
resolveAppType();
RecordLog.info("[SentinelConfig] Application type resolved: " + appType);
resolveAppName();
RecordLog.info("[SentinelConfig] Application name resolved: " + appName);
} catch (Throwable ex) {
RecordLog.warn("[SentinelConfig] Failed to initialize", ex);
ex.printStackTrace();
Expand Down Expand Up @@ -134,7 +143,7 @@ public static void setConfigIfAbsent(String key, String value) {
}

public static String getAppName() {
return AppNameUtil.getAppName();
return appName;
}

/**
Expand Down Expand Up @@ -211,5 +220,55 @@ public static int statisticMaxRt() {
}
}

/**
* method for getting application name. This class uses the flowing order to get app's name:
*
* <ol>
* <li>get {@code project.name} from System Properties, if not null, use the value as app name;</li>
* <li>get {@code project.name} from Properties file, if not null, use the value as app name;</li>
* <li>get {@code sun.java.command} from System properties, remove path, arguments and ".jar" or ".JAR"
* suffix, use the result as app name. Note that whitespace in file name or path is not allowed, or a
* wrong app name may be gotten, For example:
* <p>
* <code>
* "test.Main" -> test.Main<br/>
* "/target/test.Main" -> test.Main<br/>
* "/target/test.Main args1" -> test.Main<br/>
* "Main.jar" -> Main<br/>
* "/target/Main.JAR args1" -> Main<br/>
* "Mai n.jar" -> Mai // whitespace in file name is not allowed<br/>
* </code>
* </p>
* </li>
* </ol>
*/
public static void resolveAppName() {

if (props.get(APP_NAME) != null) {
appName = props.get(APP_NAME);
return;
}
// parse sun.java.command property
String command = System.getProperty(SUN_JAVA_COMMAND);
if (StringUtil.isBlank(command)) {
return;
}
command = command.split("\\s")[0];
String separator = File.separator;
if (command.contains(separator)) {
String[] strs;
if ("\\".equals(separator)) {
strs = command.split("\\\\");
} else {
strs = command.split(separator);
}
command = strs[strs.length - 1];
}
if (command.endsWith(JAR_SUFFIX_LOWER) || command.endsWith(JAR_SUFFIX_UPPER)) {
command = command.substring(0, command.length() - 4);
}
appName = command;
}

private SentinelConfig() {}
}
14 changes: 0 additions & 14 deletions sentinel-core/src/main/java/com/alibaba/csp/sentinel/config/SentinelConfigLoader.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ public final class SentinelConfigLoader {
public static final String SENTINEL_CONFIG_ENV_KEY = "CSP_SENTINEL_CONFIG_FILE";
public static final String SENTINEL_CONFIG_PROPERTY_KEY = "csp.sentinel.config.file";

private static final String DIR_NAME = "logs" + File.separator + "csp";
private static final String USER_HOME = "user.home";

private static final String DEFAULT_SENTINEL_CONFIG_FILE = "classpath:sentinel.properties";

private static Properties properties = new Properties();
Expand All @@ -64,17 +61,6 @@ private static void load() {
}

Properties p = ConfigUtil.loadProperties(fileName);

// Compatible with legacy config file path.
if (p == null) {
String path = addSeparator(System.getProperty(USER_HOME)) + DIR_NAME + File.separator;
fileName = path + AppNameUtil.getAppName() + ".properties";
File file = new File(fileName);
if (file.exists()) {
p = ConfigUtil.loadProperties(fileName);
}
}

if (p != null && !p.isEmpty()) {
RecordLog.info("[SentinelConfigLoader] Loading Sentinel config from " + fileName);
properties.putAll(p);
Expand Down
71 changes: 3 additions & 68 deletions sentinel-core/src/main/java/com/alibaba/csp/sentinel/util/AppNameUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,86 +15,21 @@
*/
package com.alibaba.csp.sentinel.util;

import com.alibaba.csp.sentinel.log.RecordLog;

import java.io.File;
import com.alibaba.csp.sentinel.config.SentinelConfig;

/**
* Util class for getting application name. This class uses the flowing order to get app's name:
*
* <ol>
* <li>get {@code project.name} from System Properties, if not null, use the value as app name;</li>
* <li>get {@code sun.java.command} from System properties, remove path, arguments and ".jar" or ".JAR"
* suffix, use the result as app name. Note that whitespace in file name or path is not allowed, or a
* wrong app name may be gotten, For example:
* <p>
* <code>
* "test.Main" -> test.Main<br/>
* "/target/test.Main" -> test.Main<br/>
* "/target/test.Main args1" -> test.Main<br/>
* "Main.jar" -> Main<br/>
* "/target/Main.JAR args1" -> Main<br/>
* "Mai n.jar" -> Mai // whitespace in file name is not allowed<br/>
* </code>
* </p>
* </li>
* </ol>
*
* @author Eric Zhao
* @author leyou
*/
public final class AppNameUtil {

public static final String APP_NAME = "project.name";
public static final String SUN_JAVA_COMMAND = "sun.java.command";
private static final String JAR_SUFFIX_LOWER = ".jar";
private static final String JAR_SUFFIX_UPPER = ".JAR";
public final class AppNameUtil {

private static String appName;

private AppNameUtil() {
}

static {
resolveAppName();
RecordLog.info("App name resolved: " + appName);
}

public static void resolveAppName() {
String app = System.getProperty(APP_NAME);
// use -Dproject.name first
if (!isEmpty(app)) {
appName = app;
return;
}

// parse sun.java.command property
String command = System.getProperty(SUN_JAVA_COMMAND);
if (isEmpty(command)) {
return;
}
command = command.split("\\s")[0];
String separator = File.separator;
if (command.contains(separator)) {
String[] strs;
if ("\\".equals(separator)) {
strs = command.split("\\\\");
} else {
strs = command.split(separator);
}
command = strs[strs.length - 1];
}
if (command.endsWith(JAR_SUFFIX_LOWER) || command.endsWith(JAR_SUFFIX_UPPER)) {
command = command.substring(0, command.length() - 4);
}
appName = command;
}

public static String getAppName() {
return appName;
return SentinelConfig.getAppName();
}

private static boolean isEmpty(String str) {
return str == null || "".equals(str);
}
}
5 changes: 3 additions & 2 deletions sentinel-core/src/test/java/com/alibaba/csp/sentinel/ConfigPropertyHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.io.OutputStream;
import java.util.Properties;

import com.alibaba.csp.sentinel.config.SentinelConfig;
import com.alibaba.csp.sentinel.log.LogBase;
import com.alibaba.csp.sentinel.util.AppNameUtil;

Expand All @@ -31,11 +32,11 @@
public final class ConfigPropertyHelper {

public static void setAppNameProperty(String appName) {
System.setProperty(AppNameUtil.APP_NAME, appName);
System.setProperty(SentinelConfig.APP_NAME, appName);
}

public static void clearAppNameProperty() {
System.clearProperty(AppNameUtil.APP_NAME);
System.clearProperty(SentinelConfig.APP_NAME);
}

public static void runWithConfig(Properties prop, String appName, Task task) throws Exception {
Expand Down
5 changes: 4 additions & 1 deletion sentinel-core/src/test/java/com/alibaba/csp/sentinel/config/SentinelConfigTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ public void testColdFactoryLargerThanOne() {


//add Jvm parameter
//-Dcsp.sentinel.config.file=sentinel-propertiesTest.properties
//-Dcsp.sentinel.config.file=classpath:sentinel-propertiesTest.properties
//-Dcsp.sentinel.flow.cold.factor=5
//-Dcsp.sentinel.statistic.max.rt=1000
//@Test
Expand All @@ -92,6 +92,8 @@ public void testLoadProperties() throws IOException {
out.write(buildPropertyStr(COLD_FACTOR, "123"));
out.write("\n");
out.write(buildPropertyStr(STATISTIC_MAX_RT, "6000"));
out.write("\n");
out.write(buildPropertyStr(APP_NAME, "sentinel_test"));
out.flush();
out.close();

Expand All @@ -100,6 +102,7 @@ public void testLoadProperties() throws IOException {
Assert.assertTrue(SentinelConfig.getConfig(TOTAL_METRIC_FILE_COUNT).equals("20"));
Assert.assertTrue(SentinelConfig.getConfig(COLD_FACTOR).equals("5"));
Assert.assertTrue(SentinelConfig.getConfig(STATISTIC_MAX_RT).equals("1000"));
Assert.assertTrue(SentinelConfig.getAppName().equals("sentinel_test"));

} finally {
if (file != null) {
Expand Down

0 comments on commit 744f3d6

Please sign in to comment.