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.

Possible duplicate of [Including bean definition when a profile is NOT active](http://stackoverflow.com/questions/13575201/including-bean-definition-when-a-profile-is-not-active) — g00glen00b, Feb 02 '16 at 07:03
To use class in all cases excluding one profile, you can write `@Profile("!development")` — dmitryvim, Oct 14 '16 at 08:10
Trying to track down where in the docs that "!development" syntax is outlined ... so far without any luck.@dmitryvim — James Gawron, Jun 18 '19 at 16:27

dmitryvim · Answer 1 · 2016-06-16T13:02:24.350

104

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

eureka:
  client:
    enabled: false

It's also for one profile

edited Jun 16 '16 at 13:02

answered Jun 16 '16 at 07:44

dmitryvim

1,983
4
15
27

6

Please add explanations to your answer. – Nikolay Mihaylov Jun 16 '16 at 08:11
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 – dmitryvim Oct 14 '16 at 08:09
3

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 https://cloud.spring.io/spring-cloud-netflix/multi/multi__service_discovery_eureka_clients.html#_registering_with_eureka – Karan Kaw Apr 13 '21 at 13:03
@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. – Raphael Oct 13 '22 at 23:12

patrykos91 · Accepted Answer · 2018-04-11T22:00:21.793

36

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,

edited Apr 11 '18 at 22:00

answered Feb 02 '16 at 17:01

patrykos91

3,506
2
24
30

Thanks that was what I was looking for – zinc wombat Feb 07 '16 at 00:50
Upvoting this because it's an awesome answer. – ogradyjd Nov 02 '16 at 17:21
1

People who use SO tend to copy code right away. Please fix "developement".wasted my whole hour. – Sachin Verma Apr 11 '18 at 13:32
Fixed, sorry for that. I know how big pain in the ass is looking for something like that. – patrykos91 Apr 11 '18 at 22:01
It works but stil issue occur when running the tests . – Enrico Giurin Mar 17 '20 at 15:09
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. – Robin May 24 '20 at 20:15
Using profile depending settings is technically fine but poor because it degrades the quality of your production code. – marcel Aug 09 '20 at 12:41

score 21 · Answer 3 · answered Dec 04 '18 at 10:24

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

Timi Ruprecht · Answer 4 · 2016-05-14T08:03:29.527

11

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

edited May 14 '16 at 08:03

answered May 13 '16 at 23:51

Timi Ruprecht

131
1
4

score 6 · Answer 5 · answered Aug 04 '16 at 15:23

6

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.

answered Aug 04 '16 at 15:23

Rafael

2,521
2
33
59

4

In my case this doesn't work but `eureka.client.enabled: false` does. – Ilya Serbis Oct 08 '18 at 20:49

score 6 · Answer 6 · answered Nov 14 '18 at 13:14

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

score 3 · Answer 7 · answered Apr 13 '21 at 13:06

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

How to selectively disable Eureka discovery client with Spring?

7 Answers7

Linked

Related