Instead of datasource-settings.properties, use application.yml for MySQLStorageProvider

docker/oap/docker-entrypoint.sh

@@ -136,7 +136,15 @@ generateStorageMySQL() {
     cat <<EOT >> ${var_application_file}
 storage:
   mysql:
-    metadataQueryMaxSize: \${SW_STORAGE_H2_QUERY_MAX_SIZE:5000}
+    properties:
+        jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
+        dataSource.user: ${SW_DATA_SOURCE_USER:root}
+        dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
+        dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
+        dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
+        dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
+        dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
+    metadataQueryMaxSize: \${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
 EOT
 }
 

docs/en/setup/backend/backend-storage.md

@@ -159,11 +159,18 @@ Please download MySQL driver by yourself. Copy the connection driver jar to `oap
 ```yaml
 storage:
   mysql:
+    properties:
+      jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
+      dataSource.user: ${SW_DATA_SOURCE_USER:root}
+      dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
+      dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
+      dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
+      dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
+      dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
+    metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
 ```
-
-All connection related settings including link url, username and password
-are in `datasource-settings.properties`. 
-This setting file follow [HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool document.
+All connection related settings including link url, username and password are in `application.yml`. 
+Here are some of the settings, please follow [HikariCP](https://github.com/brettwooldridge/HikariCP) connection pool document for all the settings.
 
 ## TiDB
 Currently tested TiDB in version 2.0.9, and Mysql Client driver in version 8.0.13.
@@ -172,10 +179,18 @@ Active TiDB as storage, set storage provider to **mysql**.
 ```yaml
 storage:
   mysql:
+    properties:
+      jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
+      dataSource.user: ${SW_DATA_SOURCE_USER:root}
+      dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
+      dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
+      dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
+      dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
+      dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
+    metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
 ```
-
-All connection related settings including link url, username and password
-are in `datasource-settings.properties`. And these settings can refer to the configuration of *MySQL* above.
+All connection related settings including link url, username and password are in `application.yml`. 
+These settings can refer to the configuration of *MySQL* above.
 
 ## ElasticSearch 5
 ElasticSearch 5 is incompatible with ElasticSearch 6 Java client jar, so it could not be included in native distribution.

oap-server/server-library/library-module/src/main/java/org/apache/skywalking/oap/server/library/module/ModuleDefine.java

@@ -18,12 +18,13 @@
 
 package org.apache.skywalking.oap.server.library.module;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 import java.lang.reflect.Field;
 import java.util.Enumeration;
 import java.util.Properties;
 import java.util.ServiceLoader;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
 /**
  * A module definition.
@@ -93,7 +94,7 @@ void prepare(ModuleManager moduleManager, ApplicationConfiguration.ModuleConfigu
         }
         loadedProvider.prepare();
     }
-
+    
     private void copyProperties(ModuleConfig dest, Properties src, String moduleName,
         String providerName) throws IllegalAccessException {
         if (dest == null) {
@@ -103,7 +104,6 @@ private void copyProperties(ModuleConfig dest, Properties src, String moduleName
         while (propertyNames.hasMoreElements()) {
             String propertyName = (String)propertyNames.nextElement();
             Class<? extends ModuleConfig> destClass = dest.getClass();
-
             try {
                 Field field = getDeclaredField(destClass, propertyName);
                 field.setAccessible(true);

oap-server/server-starter/pom.xml

@@ -242,7 +242,6 @@
                         <exclude>log4j2.xml</exclude>
                         <exclude>alarm-settings.yml</exclude>
                         <exclude>component-libraries.yml</exclude>
-                        <exclude>datasource-settings.properties</exclude>
                         <exclude>endpoint_naming_rules.properties</exclude>
                         <exclude>official_analysis.oal</exclude>
                         <exclude>gateways.yml</exclude>

oap-server/server-starter/src/main/assembly/application.yml

@@ -99,7 +99,15 @@ storage:
     user: ${SW_STORAGE_H2_USER:sa}
     metadataQueryMaxSize: ${SW_STORAGE_H2_QUERY_MAX_SIZE:5000}
 #  mysql:
-#    metadataQueryMaxSize: ${SW_STORAGE_H2_QUERY_MAX_SIZE:5000}
+#    properties:
+#      jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
+#      dataSource.user: ${SW_DATA_SOURCE_USER:root}
+#      dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
+#      dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
+#      dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
+#      dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
+#      dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
+#    metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
 receiver-sharing-server:
   default:
 receiver-register:

oap-server/server-starter/src/main/assembly/assembly.xml

@@ -39,7 +39,6 @@
                 <include>application.yml</include>
                 <include>alarm-settings.yml</include>
                 <include>alarm-settings-sample.yml</include>
-                <include>datasource-settings.properties</include>
                 <include>gateways.yml</include>
             </includes>
         </fileSet>

oap-server/server-starter/src/main/java/org/apache/skywalking/oap/server/starter/config/ApplicationConfigLoader.java

@@ -18,10 +18,6 @@
 
 package org.apache.skywalking.oap.server.starter.config;
 
-import java.io.FileNotFoundException;
-import java.io.Reader;
-import java.util.Map;
-import java.util.Properties;
 import org.apache.skywalking.apm.util.PropertyPlaceholderHelper;
 import org.apache.skywalking.oap.server.library.module.ApplicationConfiguration;
 import org.apache.skywalking.oap.server.library.util.CollectionUtils;
@@ -30,6 +26,11 @@
 import org.slf4j.LoggerFactory;
 import org.yaml.snakeyaml.Yaml;
 
+import java.io.FileNotFoundException;
+import java.io.Reader;
+import java.util.Map;
+import java.util.Properties;
+
 /**
  * Initialize collector settings with following sources. Use application.yml as primary setting, and fix missing setting
  * by default settings in application-default.yml.
@@ -61,21 +62,25 @@ private void loadConfig(ApplicationConfiguration configuration) throws ConfigFil
                     if (providerConfig.size() > 0) {
                         logger.info("Get a module define from application.yml, module name: {}", moduleName);
                         ApplicationConfiguration.ModuleConfiguration moduleConfiguration = configuration.addModule(moduleName);
-                        providerConfig.forEach((name, propertiesConfig) -> {
-                            logger.info("Get a provider define belong to {} module, provider name: {}", moduleName, name);
+                        providerConfig.forEach((providerName, propertiesConfig) -> {
+                            logger.info("Get a provider define belong to {} module, provider name: {}", moduleName, providerName);
                             Properties properties = new Properties();
                             if (propertiesConfig != null) {
-                                propertiesConfig.forEach((key, value) -> {
-                                    properties.put(key, value);
-                                    final Object replaceValue = yaml.load(PropertyPlaceholderHelper.INSTANCE
-                                        .replacePlaceholders(value + "", properties));
-                                    if (replaceValue != null) {
-                                        properties.replace(key, replaceValue);
+                                propertiesConfig.forEach((propertyName, propertyValue) -> {
+                                    if (propertyValue instanceof Map) {
+                                        Properties subProperties = new Properties();
+                                        ((Map) propertyValue).forEach((key, value) -> {
+                                            subProperties.put(key, value);
+                                            replacePropertyAndLog(key, value, subProperties, providerName);
+                                        });
+                                        properties.put(propertyName, subProperties);
+                                    } else {
+                                        properties.put(propertyName, propertyValue);
+                                        replacePropertyAndLog(propertyName, propertyValue, properties, providerName);
                                     }
-                                    logger.info("The property with key: {}, value: {}, in {} provider", key, replaceValue.toString(), name);
                                 });
                             }
-                            moduleConfiguration.addProviderConfiguration(name, properties);
+                            moduleConfiguration.addProviderConfiguration(providerName, properties);
                         });
                     } else {
                         logger.warn("Get a module define from application.yml, but no provider define, use default, module name: {}", moduleName);
@@ -86,6 +91,14 @@ private void loadConfig(ApplicationConfiguration configuration) throws ConfigFil
             throw new ConfigFileNotFoundException(e.getMessage(), e);
         }
     }
+
+    private void replacePropertyAndLog(final Object propertyName, final Object propertyValue, final Properties target, final Object providerName) {
+        final Object replaceValue = yaml.load(PropertyPlaceholderHelper.INSTANCE.replacePlaceholders(propertyValue + "", target));
+        if (replaceValue != null) {
+            target.replace(propertyName, replaceValue);
+            logger.info("The property with key: {}, value: {}, in {} provider", propertyName, replaceValue.toString(), providerName);
+        }
+    }
 
     private void overrideConfigBySystemEnv(ApplicationConfiguration configuration) {
         for (Map.Entry<Object, Object> prop : System.getProperties().entrySet()) {

oap-server/server-starter/src/main/resources/application.yml

@@ -98,7 +98,15 @@ storage:
 #    user: ${SW_STORAGE_H2_USER:sa}
 #    metadataQueryMaxSize: ${SW_STORAGE_H2_QUERY_MAX_SIZE:5000}
 #  mysql:
-#    metadataQueryMaxSize: ${SW_STORAGE_H2_QUERY_MAX_SIZE:5000}
+#    properties:
+#      jdbcUrl: ${SW_JDBC_URL:"jdbc:mysql://localhost:3306/swtest"}
+#      dataSource.user: ${SW_DATA_SOURCE_USER:root}
+#      dataSource.password: ${SW_DATA_SOURCE_PASSWORD:root@1234}
+#      dataSource.cachePrepStmts: ${SW_DATA_SOURCE_CACHE_PREP_STMTS:true}
+#      dataSource.prepStmtCacheSize: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_SIZE:250}
+#      dataSource.prepStmtCacheSqlLimit: ${SW_DATA_SOURCE_PREP_STMT_CACHE_SQL_LIMIT:2048}
+#      dataSource.useServerPrepStmts: ${SW_DATA_SOURCE_USE_SERVER_PREP_STMTS:true}
+#    metadataQueryMaxSize: ${SW_STORAGE_MYSQL_QUERY_MAX_SIZE:5000}
 receiver-sharing-server:
   default:
 receiver-register:

oap-server/server-storage-plugin/storage-jdbc-hikaricp-plugin/src/main/java/org/apache/skywalking/oap/server/storage/plugin/jdbc/mysql/MySQLStorageConfig.java

@@ -0,0 +1,37 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package org.apache.skywalking.oap.server.storage.plugin.jdbc.mysql;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.apache.skywalking.oap.server.library.module.ModuleConfig;
+
+import java.util.Properties;
+
+/**
+ * 
+ * @author panjuan
+ */
+@Setter
+@Getter
+public final class MySQLStorageConfig extends ModuleConfig {
+
+    private int metadataQueryMaxSize = 5000;
+    private Properties properties;
+}