SpringCloud/spring-cloud-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document how to expose refresh endpoint (#346)

Browse Source 
* Document how to expose refresh endpoint.  Fixes #343
This commit is contained in:
Ryan Baxter
2018-03-26 14:39:01 -04:00
committed by GitHub
parent 328995c639
commit 713d6a8d73
1 changed files with 12 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/src/main/asciidoc/spring-cloud-commons.adoc
View File

@@ -174,8 +174,19 @@ The `RefreshScope` is a bean in the context and has a public `refreshAll()` met
The `/refresh` endpoint exposes this functionality (over HTTP or JMX).
To refresh an individual bean by name, there is also a `refresh(String)` method.
To expose the `/refresh` endpoint, you need to add following configuration to your application:
[source,yaml]
----
management:
endpoints:
web:
exposure:
include: refresh
----
NOTE: `@RefreshScope` works (technically) on an `@Configuration` class, but it might lead to surprising behavior.
For example, it does *not* mean that all the `@Beans` defined in that class are themselves in `@RefreshScope`.
For example, it does not mean that all the `@Beans` defined in that class are themselves in `@RefreshScope`.
Specifically, anything that depends on those beans cannot rely on them being updated when a refresh is initiated, unless it is itself in `@RefreshScope`.
In that case, it is rebuilt on a refresh and its dependencies are re-injected. At that point, they are re-initialized from the refreshed `@Configuration`).