Improve Discovery support for Consul

I use consul for service-discovery and my services has a context-path:

@SpringBootApplication
@Configuration
@EnableAutoConfiguration
@ComponentScan("com.vattenfall.aot.mcf.core")
@EnableDiscoveryClient
@EnableHystrix
@ImportResource({"classpath:foo-service-spring.xml"})
public class McfFooServiceSpringBoot {

    protected static void start(String[] args) {
        SpringApplication.run(McfFooServiceSpringBoot .class, args);
    }

}

My service property:

spring.application.name=foo-service
server.port=10274
server.context-path=/bar/foo-service

spring.cloud.consul.discovery.healthCheckPath=${server.context-path}/health
spring.cloud.consul.discovery.healthCheckInterval=10s

If I start Spring-Boot-Admin like this:

@SpringBootApplication
@Configuration
@EnableAutoConfiguration
@EnableAdminServer
@EnableDiscoveryClient
public class AdminDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(AdminDemoApplication.class, args);
    }
}

and a property file like this:

spring.application.name=admin
server.port=9999

Then a wrong health-endpoint for the foo service is shown in spring boot admin UI page. And the service is shown as offline:

http://localhost:10274/health

instead of

http://localhost:10274/bar/foo-service//health

The properties spring.boot.admin.discovery.converter.* seems to has no effect. I guess the DefaultServiceInstanceConverter.convert method ignores context-path details.

[mirwais27]

As a workaround I got it also running with 1.3.3:

This is my new Consul-Converter considering the context-path of the services:

/**
 * New Converter to let Consul talk with Spring Boot Admin - even with a context-path.
 */
public class ConsulServiceInstanceConverter extends DefaultServiceInstanceConverter {

    public static final String CONTEXT_PATH = "contextPath";

    private String managementContextPath = "";
    private String healthEndpointPath = "health";

    @Override
    public Application convert(ServiceInstance instance) {
        String serviceUrl = instance.getUri().toString();
        String contextPath = instance.getMetadata().get(CONTEXT_PATH);
        serviceUrl = append(serviceUrl, contextPath);

        String managementUrl = append(serviceUrl, managementContextPath);
        String healthUrl = append(managementUrl, healthEndpointPath);

        return Application.create(instance.getServiceId()).withHealthUrl(healthUrl)
                .withManagementUrl(managementUrl).withServiceUrl(serviceUrl).build();
    }

    @Override
    public void setManagementContextPath(String managementContextPath) {
        this.managementContextPath = managementContextPath;
    }

    @Override
    public void setHealthEndpointPath(String healthEndpointPath) {
        this.healthEndpointPath = healthEndpointPath;
    }
}

And with that I enable the converter:

@SpringBootApplication
@Configuration
@EnableAdminServer
@EnableDiscoveryClient
public class MySpringBootAdminApp {

    public static void main(String[] args) {
        SpringApplication.run(MySpringBootAdminApp.class, args);
    }

    @Bean
    public DefaultServiceInstanceConverter serviceInstanceConverter() {
        ConsulServiceInstanceConverter consulServiceInstanceConverter = new ConsulServiceInstanceConverter();
        return consulServiceInstanceConverter;
    }
}

BTW: I like the fix #205 to ignoring the consul agent itself. Good job! 😃

[joshiste]

@mirwais27 not scheduled yet… but I think roughly in 2 weeks…