forked from spring-projects/spring-amqp
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
spring-projectsGH-1444: Listener Observability Initial Commit
- expand scope to include error handler: spring-projects#1287 - tracing can't be used with a batch listener (multiple messages in listener call)
- Loading branch information
1 parent
d4e0f5c
commit faba0b0
Showing
5 changed files
with
152 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
36 changes: 36 additions & 0 deletions
36
.../main/java/org/springframework/amqp/rabbit/support/micrometer/MessageReceiverContext.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
/* | ||
* Copyright 2022 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.amqp.rabbit.support.micrometer; | ||
|
||
import org.springframework.amqp.core.Message; | ||
|
||
import io.micrometer.observation.transport.ReceiverContext; | ||
|
||
/** | ||
* {@link ReceiverContext} for {@link Message}s. | ||
* | ||
* @author Gary Russell | ||
* @since 2.8 | ||
* | ||
*/ | ||
public class MessageReceiverContext extends ReceiverContext<Message> { | ||
|
||
public MessageReceiverContext(Message message) { | ||
super((carrier, key) -> carrier.getMessageProperties().getHeader(key)); | ||
} | ||
|
||
} |
72 changes: 72 additions & 0 deletions
72
...in/java/org/springframework/amqp/rabbit/support/micrometer/RabbitListenerObservation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
/* | ||
* Copyright 2022 the original author or authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* https://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
package org.springframework.amqp.rabbit.support.micrometer; | ||
|
||
import io.micrometer.common.docs.KeyName; | ||
import io.micrometer.observation.docs.DocumentedObservation; | ||
|
||
/** | ||
* Spring Rabbit Observation for listeners. | ||
* | ||
* @author Gary Russell | ||
* @since 3.0 | ||
* | ||
*/ | ||
public enum RabbitListenerObservation implements DocumentedObservation { | ||
|
||
/** | ||
* Observation for Rabbit listeners. | ||
*/ | ||
LISTENER_OBSERVATION { | ||
|
||
@Override | ||
public String getName() { | ||
return "spring.rabbit.listener"; | ||
} | ||
|
||
@Override | ||
public String getContextualName() { | ||
return "RabbitListener Observation"; | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
garyrussell
Author
Owner
|
||
} | ||
|
||
@Override | ||
public KeyName[] getLowCardinalityKeyNames() { | ||
return ListenerLowCardinalityTags.values(); | ||
} | ||
|
||
}; | ||
|
||
/** | ||
* Low cardinality tags. | ||
*/ | ||
public enum ListenerLowCardinalityTags implements KeyName { | ||
|
||
/** | ||
* Listener id. | ||
*/ | ||
LISTENER_ID { | ||
|
||
@Override | ||
public String asString() { | ||
return "listener.id"; | ||
} | ||
|
||
} | ||
|
||
} | ||
|
||
} |
6 changes: 6 additions & 0 deletions
6
...rabbit/src/main/java/org/springframework/amqp/rabbit/support/micrometer/package-info.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
/** | ||
* Provides classes for Micrometer support. | ||
*/ | ||
@org.springframework.lang.NonNullApi | ||
@org.springframework.lang.NonNullFields | ||
package org.springframework.amqp.rabbit.support.micrometer; |
I see this in the
PropagatingSenderTracingObservationHandler
:so, the plain name (in your case
spring.rabbit.listener
) is not going to be visible on a span.Or there is another logic in the super interface:
So, we need to consult with @marcingrzejszczak to be sure where to use one or another, or both.