Add property to migrate deprecated endoint IDs

Allow legacy actuator endpoint IDs that contain dots to be transparently
migrated to the new format. This update will allow Spring Cloud users
to proactively migrate from endpoints such as `hystrix.stream` to
`hystrixstream`.

Closes gh-18148
This commit is contained in:
Phillip Webb
2019-09-24 17:56:36 -07:00
parent 0a70e33009
commit 323a78c4b9
9 changed files with 102 additions and 8 deletions

View File

@@ -0,0 +1,35 @@
/*
* Copyright 2012-2019 the original author or authors.
*
* Licensed 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
*
* https://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 smoketest.actuator;
import java.util.Collections;
import java.util.Map;
import org.springframework.boot.actuate.endpoint.annotation.Endpoint;
import org.springframework.boot.actuate.endpoint.annotation.ReadOperation;
import org.springframework.stereotype.Component;
@Component
@Endpoint(id = "lega.cy")
public class SampleLegacyEndpoint {
@ReadOperation
public Map<String, String> example() {
return Collections.singletonMap("legacy", "legacy");
}
}

View File

@@ -24,3 +24,4 @@ management.endpoint.health.show-details=always
management.endpoint.health.group.ready.include=db,diskSpace
management.endpoint.health.group.live.include=example,hello,db
management.endpoint.health.group.live.show-details=never
management.endpoints.migrate-legacy-ids=true

View File

@@ -36,6 +36,7 @@ import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.entry;
/**
* Basic integration tests for service demo application.
@@ -188,6 +189,17 @@ class SampleActuatorApplicationTests {
assertThat(beans).containsKey("spring.datasource-" + DataSourceProperties.class.getName());
}
@Test
void testLegacy() {
@SuppressWarnings("rawtypes")
ResponseEntity<Map> entity = this.restTemplate.withBasicAuth("user", getPassword())
.getForEntity("/actuator/legacy", Map.class);
assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.OK);
@SuppressWarnings("unchecked")
Map<String, Object> body = entity.getBody();
assertThat(body).contains(entry("legacy", "legacy"));
}
private String getPassword() {
return "password";
}