Skip to content

Commit 468bb51

Browse files
committed
Complete Micrometer observation Javadoc
(cherry picked from commit ee87b27)
1 parent d2840fb commit 468bb51

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

src/main/java/com/rabbitmq/client/observation/micrometer/MicrometerObservationCollectorBuilder.java

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ public class MicrometerObservationCollectorBuilder {
4242
/**
4343
* Set the {@link ObservationRegistry} to use.
4444
*
45+
* <p>Default is {@link ObservationRegistry#NOOP}.
46+
*
4547
* @param registry the registry
4648
* @return this builder instance
4749
*/
@@ -55,6 +57,8 @@ public MicrometerObservationCollectorBuilder registry(ObservationRegistry regist
5557
*
5658
* <p>If not null, it will override any pre-configured conventions.
5759
*
60+
* <p>Default is <code>null</code>.
61+
*
5862
* @param customPublishObservationConvention the convention
5963
* @return this builder instance
6064
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -72,6 +76,8 @@ public MicrometerObservationCollectorBuilder customPublishObservationConvention(
7276
* <p>It will be picked if there was neither custom convention nor a pre-configured one via {@link
7377
* ObservationRegistry}.
7478
*
79+
* <p>Default is {@link DefaultPublishObservationConvention}.
80+
*
7581
* @param defaultPublishObservationConvention the convention
7682
* @return this builder instance
7783
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -88,6 +94,8 @@ public MicrometerObservationCollectorBuilder defaultPublishObservationConvention
8894
*
8995
* <p>If not null, it will override any pre-configured conventions.
9096
*
97+
* <p>Default is <code>null</code>.
98+
*
9199
* @param customProcessObservationConvention the convention
92100
* @return this builder instance
93101
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -105,6 +113,8 @@ public MicrometerObservationCollectorBuilder customProcessObservationConvention(
105113
* <p>It will be picked if there was neither custom convention nor a pre-configured one via {@link
106114
* ObservationRegistry}.
107115
*
116+
* <p>Default is <code>DefaultProcessObservationConvention("process")</code>.
117+
*
108118
* @param defaultProcessObservationConvention the convention
109119
* @return this builder instance
110120
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -121,6 +131,8 @@ public MicrometerObservationCollectorBuilder defaultProcessObservationConvention
121131
*
122132
* <p>If not null, it will override any pre-configured conventions.
123133
*
134+
* <p>Default is <code>null</code>.
135+
*
124136
* @param customReceiveObservationConvention the convention
125137
* @return this builder instance
126138
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -138,6 +150,8 @@ public MicrometerObservationCollectorBuilder customReceiveObservationConvention(
138150
* <p>It will be picked if there was neither custom convention nor a pre-configured one via {@link
139151
* ObservationRegistry}.
140152
*
153+
* <p>Default is <code>DefaultReceiveObservationConvention("receive")</code>.
154+
*
141155
* @param defaultReceiveObservationConvention the convention
142156
* @return this builder instance
143157
* @see io.micrometer.observation.docs.ObservationDocumentation#observation(ObservationConvention,
@@ -181,6 +195,11 @@ public MicrometerObservationCollectorBuilder keepObservationStartedOnBasicGet(
181195
return this;
182196
}
183197

198+
/**
199+
* Create the Micrometer {@link ObservationCollector}.
200+
*
201+
* @return the Micrometer observation collector
202+
*/
184203
public ObservationCollector build() {
185204
return new MicrometerObservationCollector(
186205
this.registry,

0 commit comments

Comments
 (0)