Skip to content

Commit 2b11825

Browse files
authored
GH-2647: Warn in docs for batch listeners and observation
Fixes: #2647 * docs: fix link for micrometer.adocˆ * docs: add note on batch listeners with observation
1 parent 22d22b9 commit 2b11825

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

src/reference/antora/modules/ROOT/pages/amqp/receiving-messages/micrometer-observation.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,4 @@ You can either subclass `DefaultRabbitTemplateObservationConvention` or `Default
1717

1818
See xref:appendix/micrometer.adoc[Micrometer Observation Documentation] for more details.
1919

20+
WARNING: Due to ambiguity in how traces should be handled in a batch, observations are *NOT* created for xref:amqp/receiving-messages/batch.adoc[Batch Listener Containers].

src/reference/antora/modules/ROOT/pages/amqp/receiving-messages/micrometer.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
[[micrometer]]
2-
= Monitoring Listener Performance
2+
= Micrometer Integration
33
:page-section-summary-toc: 1
44

5+
NOTE: This section documents the integration with https://docs.micrometer.io/micrometer/reference/[Micrometer].
6+
For integration with Micrometer Observation, see xref:amqp/receiving-messages/micrometer-observation.adoc[Micrometer Observation].
7+
58
Starting with version 2.2, the listener containers will automatically create and update Micrometer `Timer` s for the listener, if `Micrometer` is detected on the class path, and a single `MeterRegistry` is present in the application context (or exactly one is annotated `@Primary`, such as when using Spring Boot).
69
The timers can be disabled by setting the container property `micrometerEnabled` to `false`.
710

@@ -16,6 +19,3 @@ The timers are named `spring.rabbitmq.listener` and have the following tags:
1619
* `exception` : `none` or `ListenerExecutionFailedException`
1720

1821
You can add additional tags using the `micrometerTags` container property.
19-
20-
Also see xref:stream.adoc#stream-micrometer-observation[Micrometer Observation].
21-

0 commit comments

Comments
 (0)