Feature：support pushGateway push metrics (#504)
lingxiao,wu
2 years ago
committed by
GitHub
parent
10eabfe588
commit
c536c26d95
@ -0,0 +1,31 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0"
|
||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<parent>
|
||||
<artifactId>spring-cloud-tencent-plugin-starters</artifactId>
|
||||
<groupId>com.tencent.cloud</groupId>
|
||||
<version>${revision}</version>
|
||||
<relativePath>../pom.xml</relativePath>
|
||||
</parent>
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
|
||||
<artifactId>spring-cloud-tencent-pushgateway-plugin</artifactId>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>com.tencent.polaris</groupId>
|
||||
<artifactId>stat-pushgateway</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>com.tencent.cloud</groupId>
|
||||
<artifactId>spring-cloud-tencent-polaris-context</artifactId>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
</project>
|
||||
@ -0,0 +1,43 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import com.tencent.cloud.polaris.context.ConditionalOnPolarisEnabled;
|
||||
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.boot.context.properties.EnableConfigurationProperties;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.core.env.Environment;
|
||||
|
||||
/**
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@ConditionalOnPolarisEnabled
|
||||
@EnableConfigurationProperties(PolarisStatPushGatewayProperties.class)
|
||||
public class PolarisStatPushGatewayAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnMissingBean
|
||||
public PolarisStatPushGatewayModifier polarisStatPushGatewayModifier(PolarisStatPushGatewayProperties polarisStatPushGatewayProperties,
|
||||
Environment environment) {
|
||||
return new PolarisStatPushGatewayModifier(polarisStatPushGatewayProperties, environment);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.context.annotation.Import;
|
||||
|
||||
/**
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@ConditionalOnProperty("spring.cloud.polaris.enabled")
|
||||
@Import(PolarisStatPushGatewayAutoConfiguration.class)
|
||||
public class PolarisStatPushGatewayBootstrapConfiguration {
|
||||
}
|
||||
@ -0,0 +1,73 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import com.tencent.cloud.common.constant.ContextConstant;
|
||||
import com.tencent.cloud.polaris.context.PolarisConfigModifier;
|
||||
import com.tencent.polaris.factory.config.ConfigurationImpl;
|
||||
import com.tencent.polaris.plugins.stat.pushgateway.handler.PrometheusPushHandlerConfig;
|
||||
|
||||
import org.springframework.core.env.Environment;
|
||||
|
||||
/**
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
public class PolarisStatPushGatewayModifier implements PolarisConfigModifier {
|
||||
|
||||
private static final String POLARIS_STAT_ENABLED = "spring.cloud.polaris.stat.enabled";
|
||||
|
||||
private static final String PROMETHEUS_PUSH_GATEWAY_PLUGIN_NAME = "prometheus-pushgateway";
|
||||
|
||||
private final PolarisStatPushGatewayProperties polarisStatPushGatewayProperties;
|
||||
|
||||
private final Environment environment;
|
||||
|
||||
public PolarisStatPushGatewayModifier(PolarisStatPushGatewayProperties polarisStatPushGatewayProperties,
|
||||
Environment environment) {
|
||||
this.polarisStatPushGatewayProperties = polarisStatPushGatewayProperties;
|
||||
this.environment = environment;
|
||||
}
|
||||
|
||||
@Override
|
||||
public void modify(ConfigurationImpl configuration) {
|
||||
// Turn on stat reporter configuration.
|
||||
Boolean statEnabled = environment.getProperty(POLARIS_STAT_ENABLED, Boolean.class, false);
|
||||
if (!statEnabled) {
|
||||
configuration.getGlobal().getStatReporter().setEnable(polarisStatPushGatewayProperties.isEnabled());
|
||||
}
|
||||
|
||||
// Set prometheus plugin.
|
||||
if (polarisStatPushGatewayProperties.isEnabled()) {
|
||||
PrometheusPushHandlerConfig prometheusHandlerConfig = configuration.getGlobal().getStatReporter()
|
||||
.getPluginConfig(PROMETHEUS_PUSH_GATEWAY_PLUGIN_NAME, PrometheusPushHandlerConfig.class);
|
||||
prometheusHandlerConfig.setPushgatewayAddress(polarisStatPushGatewayProperties.getAddress());
|
||||
prometheusHandlerConfig.setPushgatewayNamespace(polarisStatPushGatewayProperties.getNamespace());
|
||||
prometheusHandlerConfig.setPushgatewayService(polarisStatPushGatewayProperties.getService());
|
||||
prometheusHandlerConfig.setPushInterval(polarisStatPushGatewayProperties.getPushInterval());
|
||||
configuration.getGlobal().getStatReporter()
|
||||
.setPluginConfig(PROMETHEUS_PUSH_GATEWAY_PLUGIN_NAME, prometheusHandlerConfig);
|
||||
}
|
||||
}
|
||||
|
||||
@Override
|
||||
public int getOrder() {
|
||||
// run after prometheus stat reporter.
|
||||
return ContextConstant.ModifierOrder.STAT_REPORTER_ORDER + 1;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,96 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import org.springframework.boot.context.properties.ConfigurationProperties;
|
||||
|
||||
/**
|
||||
* The properties for stat pushGateway reporter.
|
||||
*
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
@ConfigurationProperties("spring.cloud.polaris.stat.pushgateway")
|
||||
public class PolarisStatPushGatewayProperties {
|
||||
|
||||
/**
|
||||
* If state pushGateway reporter enabled.
|
||||
*/
|
||||
private boolean enabled = false;
|
||||
|
||||
/**
|
||||
* PushGateway address.
|
||||
*/
|
||||
private String address;
|
||||
|
||||
/**
|
||||
* Service for pushGateway.
|
||||
*/
|
||||
private String service;
|
||||
|
||||
/**
|
||||
* Namespace for pushGateway.
|
||||
*/
|
||||
private String namespace;
|
||||
|
||||
/**
|
||||
* Push metrics interval.
|
||||
* unit: milliseconds default 30s.
|
||||
*/
|
||||
private Long pushInterval = 30 * 1000L;
|
||||
|
||||
public boolean isEnabled() {
|
||||
return enabled;
|
||||
}
|
||||
|
||||
public void setEnabled(boolean enabled) {
|
||||
this.enabled = enabled;
|
||||
}
|
||||
|
||||
public String getAddress() {
|
||||
return address;
|
||||
}
|
||||
|
||||
public void setAddress(String address) {
|
||||
this.address = address;
|
||||
}
|
||||
|
||||
public String getService() {
|
||||
return service;
|
||||
}
|
||||
|
||||
public void setService(String service) {
|
||||
this.service = service;
|
||||
}
|
||||
|
||||
public String getNamespace() {
|
||||
return namespace;
|
||||
}
|
||||
|
||||
public void setNamespace(String namespace) {
|
||||
this.namespace = namespace;
|
||||
}
|
||||
|
||||
public Long getPushInterval() {
|
||||
return pushInterval;
|
||||
}
|
||||
|
||||
public void setPushInterval(Long pushInterval) {
|
||||
this.pushInterval = pushInterval;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,35 @@
|
||||
{
|
||||
"properties": [
|
||||
{
|
||||
"name": "spring.cloud.polaris.stat.pushgateway.address",
|
||||
"type": "java.lang.String",
|
||||
"description": "PushGateway address.",
|
||||
"sourceType": "com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayProperties"
|
||||
},
|
||||
{
|
||||
"name": "spring.cloud.polaris.stat.pushgateway.enabled",
|
||||
"type": "java.lang.Boolean",
|
||||
"description": "If state pushGateway reporter enabled.",
|
||||
"sourceType": "com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayProperties",
|
||||
"defaultValue": false
|
||||
},
|
||||
{
|
||||
"name": "spring.cloud.polaris.stat.pushgateway.namespace",
|
||||
"type": "java.lang.String",
|
||||
"description": "Namespace for pushGateway.",
|
||||
"sourceType": "com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayProperties"
|
||||
},
|
||||
{
|
||||
"name": "spring.cloud.polaris.stat.pushgateway.push-interval",
|
||||
"type": "java.lang.Long",
|
||||
"description": "Push metrics interval. unit: milliseconds default 30s.",
|
||||
"sourceType": "com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayProperties"
|
||||
},
|
||||
{
|
||||
"name": "spring.cloud.polaris.stat.pushgateway.service",
|
||||
"type": "java.lang.String",
|
||||
"description": "Service for pushGateway.",
|
||||
"sourceType": "com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayProperties"
|
||||
}
|
||||
]
|
||||
}
|
||||
@ -0,0 +1,4 @@
|
||||
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
|
||||
com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayAutoConfiguration
|
||||
org.springframework.cloud.bootstrap.BootstrapConfiguration=\
|
||||
com.tencent.cloud.plugin.pushgateway.PolarisStatPushGatewayBootstrapConfiguration
|
||||
@ -0,0 +1,47 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import org.junit.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 PolarisStatPushGatewayAutoConfiguration}.
|
||||
*
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
public class PolarisStatPushGatewayAutoConfigurationTest {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(PolarisStatPushGatewayAutoConfiguration.class));
|
||||
|
||||
@Test
|
||||
public void testDefaultInitialization() {
|
||||
this.contextRunner.run(context -> {
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayProperties.class);
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayModifier.class);
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayProperties.class);
|
||||
});
|
||||
}
|
||||
}
|
||||
@ -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.plugin.pushgateway;
|
||||
|
||||
import org.junit.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 PolarisStatPushGatewayBootstrapConfiguration}.
|
||||
*
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
public class PolarisStatPushGatewayBootstrapConfigurationTest {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(PolarisStatPushGatewayBootstrapConfiguration.class))
|
||||
.withPropertyValues("spring.cloud.polaris.enabled=true");
|
||||
|
||||
@Test
|
||||
public void testDefaultInitialization() {
|
||||
this.contextRunner.run(context -> {
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayProperties.class);
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayModifier.class);
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayProperties.class);
|
||||
assertThat(context).hasSingleBean(PolarisStatPushGatewayBootstrapConfiguration.class);
|
||||
});
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,54 @@
|
||||
/*
|
||||
* 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.plugin.pushgateway;
|
||||
|
||||
import org.junit.Assert;
|
||||
import org.junit.Test;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
|
||||
/**
|
||||
* Test for {@link PolarisStatPushGatewayProperties}.
|
||||
*
|
||||
* @author lingxiao.wlx
|
||||
*/
|
||||
public class PolarisStatPushGatewayPropertiesTest {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(PolarisStatPushGatewayBootstrapConfiguration.class))
|
||||
.withPropertyValues("spring.cloud.polaris.enabled=true")
|
||||
.withPropertyValues("spring.cloud.polaris.stat.pushgateway.enabled=true")
|
||||
.withPropertyValues("spring.cloud.polaris.stat.pushgateway.address=127.0.0.1:9091")
|
||||
.withPropertyValues("spring.cloud.polaris.stat.pushgateway.namespace=default")
|
||||
.withPropertyValues("spring.cloud.polaris.stat.pushgateway.push-interval=1000")
|
||||
.withPropertyValues("spring.cloud.polaris.stat.pushgateway.service=grpc://183.47.111.80:8091");
|
||||
|
||||
@Test
|
||||
public void polarisStatPushGatewayPropertiesTest() {
|
||||
contextRunner.run(context -> {
|
||||
PolarisStatPushGatewayProperties polarisStatPushGatewayProperties = context.getBean(PolarisStatPushGatewayProperties.class);
|
||||
Assert.assertTrue(polarisStatPushGatewayProperties.isEnabled());
|
||||
Assert.assertEquals("127.0.0.1:9091", polarisStatPushGatewayProperties.getAddress());
|
||||
Assert.assertEquals("default", polarisStatPushGatewayProperties.getNamespace());
|
||||
Assert.assertEquals("1000", polarisStatPushGatewayProperties.getPushInterval().toString());
|
||||
Assert.assertEquals("grpc://183.47.111.80:8091", polarisStatPushGatewayProperties.getService());
|
||||
});
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue