How to selectively disable Eureka discovery client with Spring?

Question

Is there a way to disable spring-boot eureka client registration based on the spring profile?

Currently I use the following annotations:

@Configuration
@EnableAutoConfiguration
@EnableDiscoveryClient
@EnableConfigServer

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

What I need is either a conditional such as (excuse the pseudo code)

@if (Profile!="development")
@EnableDiscoveryClient
@endif

Or some way in the application properties file. I have tried setting application.yml file as:

spring:
  profiles: development
  cloud:
    discovery:
      enabled: false

But this did not work.

Pumpernickel

Possible duplicate of Including bean definition when a profile is NOT active – Malayalam

To use class in all cases excluding one profile, you can write @Profile("!development") – Shipping

Trying to track down where in the docs that "!development" syntax is outlined ... so far without any luck.@Shipping – Basophil

Answer 1

Do it like this: create some @Configuration annotated class (class body can be omitted) ex.:

@Profile("!development")
@Configuration
@EnableDiscoveryClient
public class EurekaClientConfiguration {
}

It means that this configuration file (and @EnableDiscoveryClient within) will be loaded in every profile except "developement".

Hope that helps,

Seacock

Thanks that was what I was looking for – Pumpernickel

Upvoting this because it's an awesome answer. – Vexation

People who use SO tend to copy code right away. Please fix "developement".wasted my whole hour. – Zackaryzacks

Fixed, sorry for that. I know how big pain in the ass is looking for something like that. – Seacock

It works but stil issue occur when running the tests . – Manners

Still trying to figure out how to avoid this while running test! Thank you @EnricoGiurin for putting this - else I was thinking this solution isn't working. – Gustaf

Using profile depending settings is technically fine but poor because it degrades the quality of your production code. – Slobbery

Answer 2

You can disable eureka client in application.yml using this:

eureka:
  client:
    enabled: false

It's also for one profile

Shipping

Please add explanations to your answer. – Huehuebner

in application.yml or application.properties you can set spring variables in different profiles, as it was written in third question code sample. I just suggested to disable eureka this way – Shipping

To disable the Eureka Discovery Client, you can set eureka.client.enabled to false. Eureka Discovery Client will also be disabled when spring.cloud.discovery.enabled is set to false. Check Link cloud.spring.io/spring-cloud-netflix/multi/… – Valer

@KaranKaw spring.cloud.discovery.enabled is incorrect. The correct property name is spring.cloud.config.discovery.enabled, and setting that to false fixed my issue. – Localism

@KaranKaw @Localism actually, spring.cloud.discovery.enabled: false worked well for me, whereas spring.cloud.config.discovery.enabled: false did not. I'm using spring-boot 2.7.12 + spring-core 5.3.30 + spring-cloud-starter-* 3.1.1, in case it could be related with some flagging difference. – Fetlock

Answer 3

With the latest version of Spring Cloud Finchley.SR2 if you are using the annotation @EnableDiscoveryClient you have to set all of the following properties in application.properties to disable the service registration:

spring.cloud.service-registry.auto-registration.enabled=false
eureka.client.enabled=false
eureka.client.serviceUrl.registerWithEureka=false

Unkind

Answer 4

Same issue here. You can simply put in your application property file the following configuration:

  spring:
    profiles: development

  eureka:
    instance:
      hostname: localhost
    client:
      registerWithEureka: false
      fetchRegistry: false

Malvern

Answer 5

There is a standard boolean spring-cloud property

spring.cloud.discovery.enabled

This might be better than "eureka" specific since you might be using a different provider.

Pearson

In my case this doesn't work but eureka.client.enabled: false does. – Kerch

Answer 6

With the latest version of Spring boot, Please add this in the bootstrap.yml file

Spring cloud version : Edgeware: SR3 and above

spring:
  application:
    name: test
  cloud:
    service-registry:
      auto-registration:
        enabled: false

This will disable eureka. To enable it, we just need to make enabled as true

Elbertine

Answer 7

To disable the Eureka Discovery Client, you can set eureka.client.enabled to false.
Eureka Discovery Client will also be disabled when spring.cloud.discovery.enabled is set to false.

Reference
https://cloud.spring.io/spring-cloud-netflix/multi/multi__service_discovery_eureka_clients.html#_registering_with_eureka

Valer

spring.cloud.discovery.enabled: false worked well for me. Thank you @KaranKaw – Fetlock