feat: support log path configuration parameters

pull/1128/head
wenxuan70 2 years ago
parent 6a4e50ba4f
commit 1efcd58fa3

@ -16,7 +16,9 @@
*/ */
package com.tencent.cloud.polaris.context.logging; package com.tencent.cloud.polaris.context.logging;
import com.tencent.polaris.logging.LoggingConsts;
import com.tencent.polaris.logging.PolarisLogging; import com.tencent.polaris.logging.PolarisLogging;
import org.apache.commons.lang.StringUtils;
import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent; import org.springframework.boot.context.event.ApplicationEnvironmentPreparedEvent;
import org.springframework.boot.context.event.ApplicationFailedEvent; import org.springframework.boot.context.event.ApplicationFailedEvent;
@ -24,6 +26,7 @@ import org.springframework.boot.context.logging.LoggingApplicationListener;
import org.springframework.context.ApplicationEvent; import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.GenericApplicationListener; import org.springframework.context.event.GenericApplicationListener;
import org.springframework.core.ResolvableType; import org.springframework.core.ResolvableType;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.lang.NonNull; import org.springframework.lang.NonNull;
/** /**
@ -52,6 +55,22 @@ public class PolarisLoggingApplicationListener implements GenericApplicationList
@Override @Override
public void onApplicationEvent(@NonNull ApplicationEvent applicationEvent) { public void onApplicationEvent(@NonNull ApplicationEvent applicationEvent) {
ConfigurableEnvironment environment = null;
if (ApplicationEnvironmentPreparedEvent.class.isAssignableFrom(applicationEvent.getClass())) {
environment = ((ApplicationEnvironmentPreparedEvent) applicationEvent).getEnvironment();
}
else if (ApplicationFailedEvent.class.isAssignableFrom(applicationEvent.getClass())) {
environment = ((ApplicationFailedEvent) applicationEvent).getApplicationContext().getEnvironment();
}
if (environment != null) {
String loggingPath = environment.getProperty("spring.cloud.polaris.logging.path");
if (StringUtils.isNotBlank(loggingPath)) {
System.setProperty(LoggingConsts.LOGGING_PATH_PROPERTY, loggingPath);
}
}
PolarisLogging.getInstance().loadConfiguration(); PolarisLogging.getInstance().loadConfiguration();
} }
} }

@ -0,0 +1,21 @@
package com.tencent.cloud.polaris.context.logging;
import com.tencent.cloud.polaris.context.ConditionalOnPolarisEnabled;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
/**
* Autoconfiguration for polaris logging.
*
* @author wenxuan70
*/
@ConditionalOnPolarisEnabled
@EnableConfigurationProperties({PolarisLoggingProperties.class})
public class PolarisLoggingAutoConfiguration {
@Bean
public PolarisLoggingProperties polarisLoggingProperties() {
return new PolarisLoggingProperties();
}
}

@ -0,0 +1,14 @@
package com.tencent.cloud.polaris.context.logging;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Import;
/**
* Bootstrap autoconfiguration for polaris logging.
*
* @author wenxuan70
*/
@ConditionalOnProperty("spring.cloud.polaris.enabled")
@Import(PolarisLoggingAutoConfiguration.class)
public class PolarisLoggingBootstrapAutoConfiguration {
}

@ -0,0 +1,35 @@
package com.tencent.cloud.polaris.context.logging;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* The properties for polaris logging.
*
* @author wenxuan70
*/
@ConfigurationProperties(prefix = "spring.cloud.polaris.logging")
public class PolarisLoggingProperties {
/**
* logging path.
*/
@Value("${spring.cloud.polaris.logging.path:#{systemProperties['user.dir'] + T(java.io.File).separator + 'polaris' + T(java.io.File).separator + 'logs'}}")
private String path;
public String getPath() {
return path;
}
public void setPath(String path) {
System.out.println("设置spring.cloud.polaris.logging.path: " + path);
this.path = path;
}
@Override
public String toString() {
return "PolarisLoggingProperties{" +
"path='" + path + '\'' +
'}';
}
}

@ -1,7 +1,9 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration,\ com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration,\
com.tencent.cloud.polaris.context.config.PolarisContextPostConfiguration com.tencent.cloud.polaris.context.config.PolarisContextPostConfiguration,\
com.tencent.cloud.polaris.context.logging.PolarisLoggingAutoConfiguration
org.springframework.cloud.bootstrap.BootstrapConfiguration=\ org.springframework.cloud.bootstrap.BootstrapConfiguration=\
com.tencent.cloud.polaris.context.config.PolarisContextBootstrapAutoConfiguration com.tencent.cloud.polaris.context.config.PolarisContextBootstrapAutoConfiguration,\
com.tencent.cloud.polaris.context.logging.PolarisLoggingBootstrapAutoConfiguration
org.springframework.context.ApplicationListener=\ org.springframework.context.ApplicationListener=\
com.tencent.cloud.polaris.context.logging.PolarisLoggingApplicationListener com.tencent.cloud.polaris.context.logging.PolarisLoggingApplicationListener

@ -0,0 +1,31 @@
/*
* Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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 com.tencent.cloud.polaris.context;
import com.tencent.cloud.polaris.context.logging.PolarisLoggingApplicationListener;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* Test for {@link PolarisLoggingApplicationListener}.
*
* @author wenxuan70
*/
@SpringBootApplication
public class PolarisLoggingApplication {
}

@ -0,0 +1,53 @@
/*
* Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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 com.tencent.cloud.polaris.context;
import com.tencent.cloud.polaris.context.logging.PolarisLoggingApplicationListener;
import com.tencent.cloud.polaris.context.logging.PolarisLoggingAutoConfiguration;
import com.tencent.cloud.polaris.context.logging.PolarisLoggingProperties;
import com.tencent.polaris.logging.LoggingConsts;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Test for {@link PolarisLoggingApplicationListener}
*
* @author wenxuan70
*/
@ExtendWith(SpringExtension.class)
@SpringBootTest(classes = PolarisLoggingApplication.class,
properties = {"spring.config.location=classpath:bootstrap.yml"})
@ImportAutoConfiguration(PolarisLoggingAutoConfiguration.class)
public class PolarisLoggingSystemPropertyTest {
@Autowired
private PolarisLoggingProperties polarisLoggingProperties;
@Test
public void testSystemProperty() {
assertThat(polarisLoggingProperties.getPath()).isEqualTo("/tmp/polaris/logs");
assertThat(System.getProperty(LoggingConsts.LOGGING_PATH_PROPERTY)).isEqualTo("/tmp/polaris/logs");
}
}

@ -0,0 +1,48 @@
/*
* Tencent is pleased to support the open source community by making Spring Cloud Tencent available.
*
* Copyright (C) 2019 THL A29 Limited, a Tencent company. All rights reserved.
*
* Licensed under the BSD 3-Clause License (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://opensource.org/licenses/BSD-3-Clause
*
* 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 com.tencent.cloud.polaris.context.logging;
import org.junit.jupiter.api.Test;
import org.springframework.boot.autoconfigure.AutoConfigurations;
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Test for {@link PolarisLoggingAutoConfigurationTest}.
*
* @author wenxuan70
*/
public class PolarisLoggingAutoConfigurationTest {
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(PolarisLoggingAutoConfiguration.class))
.withPropertyValues(
"spring.cloud.polaris.enabled=true",
"spring.cloud.polaris.logging.path=/tmp/polaris/logs"
);
@Test
public void testProperties() {
contextRunner.run(context -> {
String loggingPath = context.getEnvironment().getProperty("spring.cloud.polaris.logging.path");
assertThat(loggingPath).isEqualTo("/tmp/polaris/logs");
});
}
}

@ -7,3 +7,5 @@ spring:
service: TestApp service: TestApp
enabled: true enabled: true
local-port: 9090 local-port: 9090
logging:
path: /tmp/polaris/logs

Loading…
Cancel
Save