Skip to content

Commit 853e8bd

Browse files
committed
Additional explanation to the binder properties
1 parent 6d3fef1 commit 853e8bd

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

extensions/micrometer/runtime/src/main/java/io/quarkus/micrometer/runtime/config/MicrometerConfig.java

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,13 @@ public interface MicrometerConfig {
3434

3535
/**
3636
* Micrometer MeterBinder discovery.
37+
* In other words, enables the automatic metrics instrumentation.
3738
* <p>
3839
* Micrometer MeterBinder implementations discovered on the classpath
39-
* will be enabled automatically by default.
40+
* will be enabled automatically by default. In other words, automatic metrics instrumentation will be ON by default.
41+
* <p>
42+
* <code>quarkus.micrometer.binder.enable-all</code> overrides this property, meaning when this is set to
43+
* <code>false</code>, and <code>enable-all</code> is true, discovery of all MeterBinder will still happen.
4044
*/
4145
@WithDefault("true")
4246
boolean binderEnabledDefault();
@@ -193,9 +197,15 @@ interface BinderConfig {
193197
NettyConfigGroup netty();
194198

195199
/**
196-
* Enable all binders. This property has precedence over all {@link BinderConfig} binders. In other words,
200+
* Enable all binders.
201+
* Activates all metrics regardless off their particular default.
202+
* <p>
203+
* This property has precedence over all {@link BinderConfig} binders. In other words,
197204
* if the <code>quarkus.micrometer.binder.jvm</code> is set to <code>false</code> and
198205
* <code>quarkus.micrometer.binder.enabled-all</code> is set to <code>true</code>, all JVM metrics will be enabled.
206+
* <p>
207+
* Also takes precedence over <code>quarkus.micrometer.binder-enabled-default</code>, if binder discover is disabled,
208+
* discovery of all metrics will still happen.
199209
*/
200210
@WithDefault("false")
201211
boolean enableAll();

0 commit comments

Comments
 (0)