feat: add circuit breaker actuator. (#1171)
Co-authored-by: wenxuan70 <t736660416@gmail.com>pull/1175/head
Haotian Zhang
1 year ago
committed by
GitHub
parent
7f2e3b9cf5
commit
050c35b522
@ -0,0 +1,90 @@
|
||||
/*
|
||||
* 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.circuitbreaker.endpoint;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.protobuf.InvalidProtocolBufferException;
|
||||
import com.google.protobuf.util.JsonFormat;
|
||||
import com.tencent.cloud.common.metadata.MetadataContext;
|
||||
import com.tencent.cloud.common.util.JacksonUtils;
|
||||
import com.tencent.cloud.polaris.context.ServiceRuleManager;
|
||||
import com.tencent.polaris.api.utils.CollectionUtils;
|
||||
import com.tencent.polaris.specification.api.v1.fault.tolerance.CircuitBreakerProto;
|
||||
import org.slf4j.Logger;
|
||||
import org.slf4j.LoggerFactory;
|
||||
|
||||
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
|
||||
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
|
||||
import org.springframework.boot.actuate.endpoint.annotation.Selector;
|
||||
|
||||
/**
|
||||
* Endpoint of polaris circuit breaker, include circuit breaker rules.
|
||||
*
|
||||
* @author wenxuan70
|
||||
*/
|
||||
@Endpoint(id = "polaris-circuit-breaker")
|
||||
public class PolarisCircuitBreakerEndpoint {
|
||||
|
||||
private static final Logger LOG = LoggerFactory.getLogger(PolarisCircuitBreakerEndpoint.class);
|
||||
|
||||
private final ServiceRuleManager serviceRuleManager;
|
||||
|
||||
public PolarisCircuitBreakerEndpoint(ServiceRuleManager serviceRuleManager) {
|
||||
this.serviceRuleManager = serviceRuleManager;
|
||||
}
|
||||
|
||||
@ReadOperation
|
||||
public Map<String, Object> circuitBreaker(@Selector String dstService) {
|
||||
List<CircuitBreakerProto.CircuitBreakerRule> rules = serviceRuleManager.getServiceCircuitBreakerRule(
|
||||
MetadataContext.LOCAL_NAMESPACE,
|
||||
MetadataContext.LOCAL_SERVICE,
|
||||
dstService
|
||||
);
|
||||
|
||||
Map<String, Object> polarisCircuitBreakerInfo = new HashMap<>();
|
||||
|
||||
polarisCircuitBreakerInfo.put("namespace", MetadataContext.LOCAL_NAMESPACE);
|
||||
polarisCircuitBreakerInfo.put("service", MetadataContext.LOCAL_SERVICE);
|
||||
|
||||
List<Object> circuitBreakerRules = new ArrayList<>();
|
||||
if (CollectionUtils.isNotEmpty(rules)) {
|
||||
for (CircuitBreakerProto.CircuitBreakerRule rule : rules) {
|
||||
circuitBreakerRules.add(parseCircuitBreakerRule(rule));
|
||||
|
||||
}
|
||||
}
|
||||
polarisCircuitBreakerInfo.put("circuitBreakerRules", circuitBreakerRules);
|
||||
return polarisCircuitBreakerInfo;
|
||||
}
|
||||
|
||||
private Object parseCircuitBreakerRule(CircuitBreakerProto.CircuitBreakerRule circuitBreakerRule) {
|
||||
String ruleJson;
|
||||
try {
|
||||
ruleJson = JsonFormat.printer().print(circuitBreakerRule);
|
||||
}
|
||||
catch (InvalidProtocolBufferException e) {
|
||||
LOG.error("rule to Json failed. check rule {}.", circuitBreakerRule, e);
|
||||
throw new RuntimeException("Json failed.", e);
|
||||
}
|
||||
return JacksonUtils.deserialize2Map(ruleJson);
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,49 @@
|
||||
/*
|
||||
* 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.circuitbreaker.endpoint;
|
||||
|
||||
import com.tencent.cloud.polaris.circuitbreaker.config.ConditionalOnPolarisCircuitBreakerEnabled;
|
||||
import com.tencent.cloud.polaris.context.ServiceRuleManager;
|
||||
|
||||
import org.springframework.boot.actuate.autoconfigure.endpoint.condition.ConditionalOnAvailableEndpoint;
|
||||
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
|
||||
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
|
||||
/**
|
||||
* The AutoConfiguration for Polaris CircuitBreaker's Endpoint.
|
||||
*
|
||||
* @author wenxuan70
|
||||
*/
|
||||
@Configuration(proxyBeanMethods = false)
|
||||
@ConditionalOnClass(Endpoint.class)
|
||||
@ConditionalOnPolarisCircuitBreakerEnabled
|
||||
public class PolarisCircuitBreakerEndpointAutoConfiguration {
|
||||
|
||||
@Bean
|
||||
@ConditionalOnBean(ServiceRuleManager.class)
|
||||
@ConditionalOnMissingBean
|
||||
@ConditionalOnAvailableEndpoint
|
||||
public PolarisCircuitBreakerEndpoint polarisCircuitBreakerEndpoint(ServiceRuleManager serviceRuleManager) {
|
||||
return new PolarisCircuitBreakerEndpoint(serviceRuleManager);
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,50 @@
|
||||
/*
|
||||
* 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.circuitbreaker.endpoint;
|
||||
|
||||
import com.tencent.cloud.polaris.circuitbreaker.config.PolarisCircuitBreakerAutoConfiguration;
|
||||
import com.tencent.cloud.polaris.context.config.PolarisContextAutoConfiguration;
|
||||
import com.tencent.cloud.rpc.enhancement.config.RpcEnhancementAutoConfiguration;
|
||||
import org.junit.jupiter.api.Test;
|
||||
|
||||
import org.springframework.boot.autoconfigure.AutoConfigurations;
|
||||
import org.springframework.boot.test.context.runner.WebApplicationContextRunner;
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
|
||||
/**
|
||||
* Test for {@link PolarisCircuitBreakerEndpointAutoConfiguration}.
|
||||
*
|
||||
* @author wenxuan70
|
||||
*/
|
||||
public class PolarisCircuitBreakerEndpointAutoConfigurationTest {
|
||||
|
||||
private final WebApplicationContextRunner contextRunner = new WebApplicationContextRunner()
|
||||
.withConfiguration(AutoConfigurations.of(
|
||||
PolarisContextAutoConfiguration.class,
|
||||
RpcEnhancementAutoConfiguration.class,
|
||||
PolarisCircuitBreakerAutoConfiguration.class,
|
||||
PolarisCircuitBreakerEndpointAutoConfiguration.class
|
||||
))
|
||||
.withPropertyValues("management.endpoints.web.exposure.include=polaris-circuit-breaker");
|
||||
|
||||
@Test
|
||||
public void testEndpointInitialization() {
|
||||
contextRunner.run(context -> assertThat(context).hasSingleBean(PolarisCircuitBreakerEndpoint.class));
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,84 @@
|
||||
/*
|
||||
* 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.circuitbreaker.endpoint;
|
||||
|
||||
import java.util.Map;
|
||||
|
||||
import com.google.protobuf.StringValue;
|
||||
import com.tencent.cloud.common.util.ApplicationContextAwareUtils;
|
||||
import com.tencent.cloud.polaris.context.ServiceRuleManager;
|
||||
import com.tencent.polaris.specification.api.v1.fault.tolerance.CircuitBreakerProto;
|
||||
import com.tencent.polaris.specification.api.v1.model.ModelProto;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.junit.jupiter.MockitoExtension;
|
||||
|
||||
import org.springframework.boot.test.context.runner.ApplicationContextRunner;
|
||||
|
||||
import static com.tencent.polaris.test.common.Consts.NAMESPACE_TEST;
|
||||
import static com.tencent.polaris.test.common.Consts.SERVICE_PROVIDER;
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.anyString;
|
||||
import static org.mockito.Mockito.mock;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* Test for {@link PolarisCircuitBreakerEndpoint}.
|
||||
*
|
||||
* @author wenxuan70
|
||||
*/
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
public class PolarisCircuitBreakerEndpointTest {
|
||||
|
||||
private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
|
||||
.withBean(ApplicationContextAwareUtils.class)
|
||||
.withPropertyValues("spring.cloud.polaris.namespace=" + NAMESPACE_TEST)
|
||||
.withPropertyValues("spring.cloud.polaris.service=" + SERVICE_PROVIDER);
|
||||
|
||||
private ServiceRuleManager serviceRuleManager;
|
||||
|
||||
@BeforeEach
|
||||
void setUp() {
|
||||
serviceRuleManager = mock(ServiceRuleManager.class);
|
||||
when(serviceRuleManager.getServiceCircuitBreakerRule(anyString(), anyString(), anyString())).thenAnswer(invocation -> {
|
||||
CircuitBreakerProto.CircuitBreakerRule.Builder ruleBuilder = CircuitBreakerProto.CircuitBreakerRule.newBuilder();
|
||||
ruleBuilder.setName("test_for_circuit_breaker");
|
||||
ruleBuilder.setEnable(true);
|
||||
ruleBuilder.setLevel(CircuitBreakerProto.Level.METHOD);
|
||||
CircuitBreakerProto.RuleMatcher.Builder rmBuilder = CircuitBreakerProto.RuleMatcher.newBuilder();
|
||||
rmBuilder.setDestination(CircuitBreakerProto.RuleMatcher.DestinationService.newBuilder().setNamespace("default").setService("svc2").setMethod(
|
||||
ModelProto.MatchString.newBuilder().setValue(StringValue.newBuilder().setValue("*").build()).build()).build());
|
||||
rmBuilder.setSource(CircuitBreakerProto.RuleMatcher.SourceService.newBuilder().setNamespace("*").setService("*").build());
|
||||
ruleBuilder.setRuleMatcher(rmBuilder.build());
|
||||
return CircuitBreakerProto.CircuitBreaker.newBuilder().addRules(ruleBuilder.build()).build().getRulesList();
|
||||
});
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testPolarisCircuitBreaker() {
|
||||
contextRunner.run(context -> {
|
||||
PolarisCircuitBreakerEndpoint endpoint = new PolarisCircuitBreakerEndpoint(serviceRuleManager);
|
||||
Map<String, Object> circuitBreakerInfo = endpoint.circuitBreaker("test");
|
||||
assertThat(circuitBreakerInfo).isNotNull();
|
||||
assertThat(circuitBreakerInfo.get("namespace")).isNotNull();
|
||||
assertThat(circuitBreakerInfo.get("service")).isNotNull();
|
||||
assertThat(circuitBreakerInfo.get("circuitBreakerRules")).asList().isNotEmpty();
|
||||
});
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,169 @@
|
||||
/*
|
||||
* 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 java.util.List;
|
||||
|
||||
import com.tencent.polaris.api.core.ConsumerAPI;
|
||||
import com.tencent.polaris.api.pojo.ServiceEventKey;
|
||||
import com.tencent.polaris.api.pojo.ServiceRule;
|
||||
import com.tencent.polaris.api.rpc.ServiceRuleResponse;
|
||||
import com.tencent.polaris.client.api.SDKContext;
|
||||
import com.tencent.polaris.client.pojo.ServiceRuleByProto;
|
||||
import com.tencent.polaris.specification.api.v1.fault.tolerance.CircuitBreakerProto;
|
||||
import com.tencent.polaris.specification.api.v1.traffic.manage.RateLimitProto;
|
||||
import com.tencent.polaris.specification.api.v1.traffic.manage.RoutingProto;
|
||||
import org.junit.jupiter.api.BeforeEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.junit.jupiter.api.extension.ExtendWith;
|
||||
import org.mockito.Answers;
|
||||
import org.mockito.Mock;
|
||||
import org.mockito.junit.jupiter.MockitoExtension;
|
||||
|
||||
|
||||
import static org.assertj.core.api.Assertions.assertThat;
|
||||
import static org.mockito.ArgumentMatchers.argThat;
|
||||
import static org.mockito.Mockito.when;
|
||||
|
||||
/**
|
||||
* Test for {@link ServiceRuleManager}.
|
||||
*
|
||||
* @author wenxuan70
|
||||
*/
|
||||
@ExtendWith(MockitoExtension.class)
|
||||
public class ServiceRuleManagerTest {
|
||||
|
||||
@Mock(answer = Answers.RETURNS_DEEP_STUBS)
|
||||
private SDKContext sdkContext;
|
||||
|
||||
@Mock
|
||||
private ConsumerAPI consumerAPI;
|
||||
|
||||
@BeforeEach
|
||||
public void setUp() {
|
||||
when(sdkContext.getConfig().getGlobal().getAPI().getTimeout()).thenReturn(500L);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetServiceCircuitBreakerRule() {
|
||||
final String testNamespace = "testNamespace";
|
||||
final String testSourceService = "testSourceService";
|
||||
final String testDstService = "testDstService";
|
||||
|
||||
CircuitBreakerProto.CircuitBreaker circuitBreaker = CircuitBreakerProto.CircuitBreaker.newBuilder()
|
||||
.addRules(CircuitBreakerProto.CircuitBreakerRule.newBuilder().build())
|
||||
.build();
|
||||
ServiceRuleByProto serviceRule = new ServiceRuleByProto(circuitBreaker,
|
||||
"111",
|
||||
false,
|
||||
ServiceEventKey.EventType.CIRCUIT_BREAKING);
|
||||
ServiceRuleResponse serviceRuleResponse = new ServiceRuleResponse(serviceRule);
|
||||
|
||||
// source
|
||||
when(consumerAPI.getServiceRule(
|
||||
argThat(request -> request != null
|
||||
&& testNamespace.equals(request.getNamespace())
|
||||
&& testSourceService.equals(request.getService())
|
||||
&& ServiceEventKey.EventType.CIRCUIT_BREAKING.equals(request.getRuleType()))
|
||||
)).thenReturn(serviceRuleResponse);
|
||||
|
||||
ServiceRuleResponse emptyRuleResponse = new ServiceRuleResponse(null);
|
||||
|
||||
// destination
|
||||
when(consumerAPI.getServiceRule(
|
||||
argThat(request -> request != null
|
||||
&& testNamespace.equals(request.getNamespace())
|
||||
&& testDstService.equals(request.getService())
|
||||
&& ServiceEventKey.EventType.CIRCUIT_BREAKING.equals(request.getRuleType()))
|
||||
)).thenReturn(emptyRuleResponse);
|
||||
|
||||
ServiceRuleManager serviceRuleManager = new ServiceRuleManager(sdkContext, consumerAPI);
|
||||
List<CircuitBreakerProto.CircuitBreakerRule> serviceCircuitBreakerRule = serviceRuleManager.getServiceCircuitBreakerRule(testNamespace,
|
||||
testSourceService,
|
||||
testDstService);
|
||||
|
||||
assertThat(serviceCircuitBreakerRule).hasSize(1);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetServiceRouterRule() {
|
||||
final String testNamespace = "testNamespace";
|
||||
final String testSourceService = "testSourceService";
|
||||
final String testDstService = "testDstService";
|
||||
|
||||
RoutingProto.Routing routing = RoutingProto.Routing.newBuilder()
|
||||
.addOutbounds(RoutingProto.Route.newBuilder().build())
|
||||
.build();
|
||||
ServiceRule serviceRule = new ServiceRuleByProto(routing,
|
||||
"111",
|
||||
false,
|
||||
ServiceEventKey.EventType.ROUTING);
|
||||
ServiceRuleResponse serviceRuleResponse = new ServiceRuleResponse(serviceRule);
|
||||
|
||||
// source
|
||||
when(consumerAPI.getServiceRule(
|
||||
argThat(request -> request != null
|
||||
&& testNamespace.equals(request.getNamespace())
|
||||
&& testSourceService.equals(request.getService())
|
||||
&& ServiceEventKey.EventType.ROUTING.equals(request.getRuleType()))
|
||||
)).thenReturn(serviceRuleResponse);
|
||||
|
||||
|
||||
ServiceRuleResponse emptyRuleResponse = new ServiceRuleResponse(null);
|
||||
|
||||
// destination
|
||||
when(consumerAPI.getServiceRule(
|
||||
argThat(request -> request != null
|
||||
&& testNamespace.equals(request.getNamespace())
|
||||
&& testDstService.equals(request.getService())
|
||||
&& ServiceEventKey.EventType.ROUTING.equals(request.getRuleType()))
|
||||
)).thenReturn(emptyRuleResponse);
|
||||
|
||||
ServiceRuleManager serviceRuleManager = new ServiceRuleManager(sdkContext, consumerAPI);
|
||||
List<RoutingProto.Route> serviceRouterRule = serviceRuleManager.getServiceRouterRule(testNamespace,
|
||||
testSourceService,
|
||||
testDstService);
|
||||
|
||||
assertThat(serviceRouterRule).hasSize(1);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void testGetServiceRateLimitRule() {
|
||||
final String testNamespace = "testNamespace";
|
||||
final String testService = "testService";
|
||||
|
||||
RateLimitProto.RateLimit rateLimit = RateLimitProto.RateLimit.getDefaultInstance();
|
||||
ServiceRule serviceRule = new ServiceRuleByProto(rateLimit,
|
||||
"111",
|
||||
false,
|
||||
ServiceEventKey.EventType.ROUTING);
|
||||
ServiceRuleResponse serviceRuleResponse = new ServiceRuleResponse(serviceRule);
|
||||
|
||||
when(consumerAPI.getServiceRule(
|
||||
argThat(request -> request != null
|
||||
&& testNamespace.equals(request.getNamespace())
|
||||
&& testService.equals(request.getService())
|
||||
&& ServiceEventKey.EventType.RATE_LIMITING.equals(request.getRuleType()))
|
||||
)).thenReturn(serviceRuleResponse);
|
||||
|
||||
ServiceRuleManager serviceRuleManager = new ServiceRuleManager(sdkContext, consumerAPI);
|
||||
RateLimitProto.RateLimit rateLimitRule = serviceRuleManager.getServiceRateLimitRule(testNamespace, testService);
|
||||
|
||||
assertThat(rateLimitRule).isNotNull();
|
||||
}
|
||||
}
|
||||
Loading…
Reference in new issue