spring-jms support

[codefromthecrypt]

#584 added JMS support, including message listeners. Not all libraries use JMSConsumer.setMessageListener(listener) or MessageConsumer.setMessageListener(listener). Notably, spring supports other means to invoke. This means we'll need to provide hooks to wrap similarly when in Spring.

This likely means handling the following:

• JmsMessageEndpointManager - implicitly backfilling JCA connector tests
• DefaultMessageListenerContainer
• SimpleMessageListenerContainer

[codefromthecrypt]

when we do this we have to be very careful when wrapping as there is dispatch logic like this:

package org.springframework.jms.config;

public abstract class AbstractJmsListenerEndpoint implements JmsListenerEndpoint {
	@Override
	public void setupListenerContainer(MessageListenerContainer listenerContainer) {
		if (listenerContainer instanceof AbstractMessageListenerContainer) {
			setupJmsListenerContainer((AbstractMessageListenerContainer) listenerContainer);
		}
		else {
			new JcaEndpointConfigurer().configureEndpoint(listenerContainer);
		}
	}

For example, the type AbstractMessageListenerContainer is inspected, so we shouldn't wrap using that type unless the delegate is also that type!

[codefromthecrypt]

PS the TracingMessageListener which we use internally in JmsTracing won't be used for something like Spring in the same way. the TracingMessageListener we have in normal JMS starts both a producer and a consumer span. In the case of Spring, it is calling "receive" hence has already made a consumer span: we only want to create a child and scope that span around the invoked listener.

Our tests should prove there is only one CONSUMER span in other words, to ensure no double-instrumentation.

https://github.com/openzipkin/sleuth-webmvc-example/compare/add-jms-tracing

[codefromthecrypt]

to the point about dual hierarchy:

java.lang.IllegalArgumentException: Could not configure endpoint with the specified container 'sleuth.webmvc.JmsConfiguration$TracingForwardingJmsListenerEndpoint$1@6ef2f7ad' Only JMS (org.springframework.jms.listener.AbstractMessageListenerContainer subclass) or JCA (org.springframework.jms.listener.endpoint.JmsMessageEndpointManager) are supported.

[codefromthecrypt]

added a commit to https://github.com/openzipkin/sleuth-webmvc-example/compare/add-jms-tracing which adds receiver spans for basic message listeners. Will test more later

[codefromthecrypt]

branch now works with all listeners except JCA. will try to wrap that up tomorrow.. We also need to test topic subscription to ensure there are no state problems (like listeners getting exact same instance of JMS Message and therefore getting into overlap writes trouble)

[varpa89]

@adriancole any news?

[frankpolkm]

Checkout the add-jms-tracing branch, the jms sending is OK, but listener doesn't work. Also, need add spring.main.allow-bean-definition-overriding=true to start the backend. Would you please provide a working sample for the 2.1.0 release?

[codefromthecrypt]

@frankpolkm can you clarify if you are primarily interested in usage via sleuth or brave directly?