-
Notifications
You must be signed in to change notification settings - Fork 495
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: add circuit breaker actuator (#1136)
- Loading branch information
Showing
7 changed files
with
250 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
86 changes: 86 additions & 0 deletions
86
...java/com/tencent/cloud/polaris/circuitbreaker/endpoint/PolarisCircuitBreakerEndpoint.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| /* | ||
| * 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.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; | ||
|
|
||
| /** | ||
| * 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() { | ||
| CircuitBreakerProto.CircuitBreaker circuitBreaker = serviceRuleManager.getServiceCircuitBreakerRule( | ||
| MetadataContext.LOCAL_NAMESPACE, | ||
| MetadataContext.LOCAL_SERVICE | ||
| ); | ||
|
|
||
| Map<String, Object> polarisCircuitBreakerInfo = new HashMap<>(); | ||
|
|
||
| polarisCircuitBreakerInfo.put("namespace", MetadataContext.LOCAL_NAMESPACE); | ||
| polarisCircuitBreakerInfo.put("service", MetadataContext.LOCAL_SERVICE); | ||
| polarisCircuitBreakerInfo.put("circuitBreakerRules", parseCircuitBreakerRule(circuitBreaker)); | ||
|
|
||
| return polarisCircuitBreakerInfo; | ||
| } | ||
|
|
||
| private List<Object> parseCircuitBreakerRule(CircuitBreakerProto.CircuitBreaker circuitBreaker) { | ||
| List<Object> circuitBreakerRuleList = new ArrayList<>(); | ||
|
|
||
| for (CircuitBreakerProto.CircuitBreakerRule circuitBreakerRule : circuitBreaker.getRulesList()) { | ||
| 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); | ||
| } | ||
| circuitBreakerRuleList.add(JacksonUtils.deserialize2Map(ruleJson)); | ||
| } | ||
|
|
||
| return circuitBreakerRuleList; | ||
| } | ||
| } |
49 changes: 49 additions & 0 deletions
49
...cloud/polaris/circuitbreaker/endpoint/PolarisCircuitBreakerEndpointAutoConfiguration.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
84 changes: 84 additions & 0 deletions
84
.../com/tencent/cloud/polaris/circuitbreaker/endpoint/PolarisCircuitBreakerEndpointTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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())).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(); | ||
| }); | ||
| } | ||
|
|
||
| @Test | ||
| public void testPolarisCircuitBreaker() { | ||
| contextRunner.run(context -> { | ||
| PolarisCircuitBreakerEndpoint endpoint = new PolarisCircuitBreakerEndpoint(serviceRuleManager); | ||
| Map<String, Object> circuitBreakerInfo = endpoint.circuitBreaker(); | ||
| assertThat(circuitBreakerInfo).isNotNull(); | ||
| assertThat(circuitBreakerInfo.get("namespace")).isNotNull(); | ||
| assertThat(circuitBreakerInfo.get("service")).isNotNull(); | ||
| assertThat(circuitBreakerInfo.get("circuitBreakerRules")).asList().isNotEmpty(); | ||
| }); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters