You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: framework-docs/modules/ROOT/pages/integration/jms/using.adoc
+8-6
Original file line number
Diff line number
Diff line change
@@ -167,13 +167,15 @@ operations that do not refer to a specific destination.
167
167
168
168
One of the most common uses of JMS messages in the EJB world is to drive message-driven
169
169
beans (MDBs). Spring offers a solution to create message-driven POJOs (MDPs) in a way
170
-
that does not tie a user to an EJB container. (See xref:integration/jms/receiving.adoc#jms-receiving-async[Asynchronous reception: Message-Driven POJOs] for detailed
171
-
coverage of Spring's MDP support.) Since Spring Framework 4.1, endpoint methods can be
172
-
annotated with `@JmsListener` -- see xref:integration/jms/annotated.adoc[Annotation-driven Listener Endpoints] for more details.
170
+
that does not tie a user to an EJB container. (See
Copy file name to clipboardExpand all lines: framework-docs/modules/ROOT/pages/integration/observability.adoc
+14-14
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ As outlined xref:integration/observability.adoc[at the beginning of this section
37
37
|Processing time for an execution of a `@Scheduled` task
38
38
|===
39
39
40
-
NOTE: Observations are using Micrometer's official naming convention, but Metrics names will be automatically converted
40
+
NOTE: Observations use Micrometer's official naming convention, but Metrics names will be automatically converted
41
41
{micrometer-docs}/concepts/naming.html[to the format preferred by the monitoring system backend]
42
42
(Prometheus, Atlas, Graphite, InfluxDB...).
43
43
@@ -97,7 +97,7 @@ This can be done by declaring a `SchedulingConfigurer` bean that sets the observ
97
97
98
98
include-code::./ObservationSchedulingConfigurer[]
99
99
100
-
It is using the `org.springframework.scheduling.support.DefaultScheduledTaskObservationConvention` by default, backed by the `ScheduledTaskObservationContext`.
100
+
It uses the `org.springframework.scheduling.support.DefaultScheduledTaskObservationConvention` by default, backed by the `ScheduledTaskObservationContext`.
101
101
You can configure a custom implementation on the `ObservationRegistry` directly.
102
102
During the execution of the scheduled method, the current observation is restored in the `ThreadLocal` context or the Reactor context (if the scheduled method returns a `Mono` or `Flux` type).
103
103
@@ -107,7 +107,7 @@ By default, the following `KeyValues` are created:
107
107
[cols="a,a"]
108
108
|===
109
109
|Name | Description
110
-
|`code.function` _(required)_|Name of Java `Method` that is scheduled for execution.
110
+
|`code.function` _(required)_|Name of the Java `Method` that is scheduled for execution.
111
111
|`code.namespace` _(required)_|Canonical name of the class of the bean instance that holds the scheduled method, or `"ANONYMOUS"` for anonymous classes.
112
112
|`error` _(required)_|Class name of the exception thrown during the execution, or `"none"` if no exception happened.
113
113
|`exception` _(deprecated)_|Duplicates the `error` key and might be removed in the future.
@@ -126,7 +126,7 @@ This instrumentation will create 2 types of observations:
126
126
* `"jms.message.publish"` when a JMS message is sent to the broker, typically with `JmsTemplate`.
127
127
* `"jms.message.process"` when a JMS message is processed by the application, typically with a `MessageListener` or a `@JmsListener` annotated method.
128
128
129
-
NOTE: currently there is no instrumentation for `"jms.message.receive"` observations as there is little value in measuring the time spent waiting for the reception of a message.
129
+
NOTE: Currently there is no instrumentation for `"jms.message.receive"` observations as there is little value in measuring the time spent waiting for the receipt of a message.
130
130
Such an integration would typically instrument `MessageConsumer#receive` method calls. But once those return, the processing time is not measured and the trace scope cannot be propagated to the application.
131
131
132
132
By default, both observations share the same set of possible `KeyValues`:
@@ -138,15 +138,15 @@ By default, both observations share the same set of possible `KeyValues`:
138
138
|`error` |Class name of the exception thrown during the messaging operation (or "none").
139
139
|`exception` _(deprecated)_|Duplicates the `error` key and might be removed in the future.
140
140
|`messaging.destination.temporary` _(required)_|Whether the destination is a `TemporaryQueue` or `TemporaryTopic` (values: `"true"` or `"false"`).
141
-
|`messaging.operation` _(required)_|Name of JMS operation being performed (values: `"publish"` or `"process"`).
141
+
|`messaging.operation` _(required)_|Name of the JMS operation being performed (values: `"publish"` or `"process"`).
142
142
|===
143
143
144
144
.High cardinality Keys
145
145
[cols="a,a"]
146
146
|===
147
147
|Name | Description
148
148
|`messaging.message.conversation_id` |The correlation ID of the JMS message.
149
-
|`messaging.destination.name` |The name of destination the current message was sent to.
149
+
|`messaging.destination.name` |The name of the destination the current message was sent to.
150
150
|`messaging.message.id` |Value used by the messaging system as an identifier for the message.
151
151
|===
152
152
@@ -213,7 +213,7 @@ By default, the following `KeyValues` are created:
213
213
|Name | Description
214
214
|`error` _(required)_|Class name of the exception thrown during the exchange, or `"none"` if no exception happened.
215
215
|`exception` _(deprecated)_|Duplicates the `error` key and might be removed in the future.
216
-
|`method` _(required)_|Name of HTTP request method or `"none"` if not a well-known method.
216
+
|`method` _(required)_|Name of the HTTP request method or `"none"` if not a well-known method.
217
217
|`outcome` _(required)_|Outcome of the HTTP server exchange.
218
218
|`status` _(required)_|HTTP response raw status code, or `"UNKNOWN"` if no response was created.
219
219
|`uri` _(required)_|URI pattern for the matching handler if available, falling back to `REDIRECTION` for 3xx responses, `NOT_FOUND` for 404 responses, `root` for requests with no path info, and `UNKNOWN` for all other requests.
@@ -235,10 +235,10 @@ This can be done on the `WebHttpHandlerBuilder`, as follows:
235
235
236
236
include-code::./HttpHandlerConfiguration[]
237
237
238
-
It is using the `org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention` by default, backed by the `ServerRequestObservationContext`.
238
+
It uses the `org.springframework.http.server.reactive.observation.DefaultServerRequestObservationConvention` by default, backed by the `ServerRequestObservationContext`.
239
239
240
240
This will only record an observation as an error if the `Exception` has not been handled by an application Controller.
241
-
Typically, all exceptions handled by Spring WebFlux's `@ExceptionHandler` and <<web.adoc#webflux-ann-rest-exceptions,`ProblemDetail` support>> will not be recorded with the observation.
241
+
Typically, all exceptions handled by Spring WebFlux's `@ExceptionHandler` and xref:web/webflux/ann-rest-exceptions.adoc[`ProblemDetail` support] will not be recorded with the observation.
242
242
You can, at any point during request processing, set the error field on the `ObservationContext` yourself:
243
243
244
244
include-code::./UserController[]
@@ -251,7 +251,7 @@ By default, the following `KeyValues` are created:
251
251
|Name | Description
252
252
|`error` _(required)_|Class name of the exception thrown during the exchange, or `"none"` if no exception happened.
253
253
|`exception` _(deprecated)_|Duplicates the `error` key and might be removed in the future.
254
-
|`method` _(required)_|Name of HTTP request method or `"none"` if not a well-known method.
254
+
|`method` _(required)_|Name of the HTTP request method or `"none"` if not a well-known method.
255
255
|`outcome` _(required)_|Outcome of the HTTP server exchange.
256
256
|`status` _(required)_|HTTP response raw status code, or `"UNKNOWN"` if no response was created.
257
257
|`uri` _(required)_|URI pattern for the matching handler if available, falling back to `REDIRECTION` for 3xx responses, `NOT_FOUND` for 404 responses, `root` for requests with no path info, and `UNKNOWN` for all other requests.
@@ -284,7 +284,7 @@ Instrumentation uses the `org.springframework.http.client.observation.ClientRequ
284
284
[cols="a,a"]
285
285
|===
286
286
|Name | Description
287
-
|`method` _(required)_|Name of HTTP request method or `"none"` if not a well-known method.
287
+
|`method` _(required)_|Name of the HTTP request method or `"none"` if not a well-known method.
288
288
|`uri` _(required)_|URI template used for HTTP request, or `"none"` if none was provided. Only the path part of the URI is considered.
289
289
|`client.name` _(required)_|Client name derived from the request URI host.
290
290
|`status` _(required)_|HTTP response raw status code, or `"IO_ERROR"` in case of `IOException`, or `"CLIENT_ERROR"` if no response was received.
@@ -312,7 +312,7 @@ Instrumentation uses the `org.springframework.http.client.observation.ClientRequ
312
312
[cols="a,a"]
313
313
|===
314
314
|Name | Description
315
-
|`method` _(required)_|Name of HTTP request method or `"none"` if the request could not be created.
315
+
|`method` _(required)_|Name of the HTTP request method or `"none"` if the request could not be created.
316
316
|`uri` _(required)_|URI template used for HTTP request, or `"none"` if none was provided. Only the path part of the URI is considered.
317
317
|`client.name` _(required)_|Client name derived from the request URI host.
318
318
|`status` _(required)_|HTTP response raw status code, or `"IO_ERROR"` in case of `IOException`, or `"CLIENT_ERROR"` if no response was received.
@@ -332,7 +332,7 @@ Instrumentation uses the `org.springframework.http.client.observation.ClientRequ
332
332
[[observability.http-client.webclient]]
333
333
=== WebClient
334
334
335
-
Applications must configure an `ObservationRegistry` on the `WebClient` builder to enable the instrumentation; without that, observations are "no-ops".
335
+
Applications must configure an `ObservationRegistry` on the `WebClient.Builder` to enable the instrumentation; without that, observations are "no-ops".
336
336
Spring Boot will auto-configure `WebClient.Builder` beans with the observation registry already set.
337
337
338
338
Instrumentation uses the `org.springframework.web.reactive.function.client.ClientRequestObservationConvention` by default, backed by the `ClientRequestObservationContext`.
@@ -341,7 +341,7 @@ Instrumentation uses the `org.springframework.web.reactive.function.client.Clien
341
341
[cols="a,a"]
342
342
|===
343
343
|Name | Description
344
-
|`method` _(required)_|Name of HTTP request method or `"none"` if not a well-known method.
344
+
|`method` _(required)_|Name of the HTTP request method or `"none"` if not a well-known method.
345
345
|`uri` _(required)_|URI template used for HTTP request, or `"none"` if none was provided. Only the path part of the URI is considered.
346
346
|`client.name` _(required)_|Client name derived from the request URI host.
347
347
|`status` _(required)_|HTTP response raw status code, or `"IO_ERROR"` in case of `IOException`, or `"CLIENT_ERROR"` if no response was received.
0 commit comments