2929import org .apache .pulsar .client .api .TypedMessageBuilder ;
3030import org .apache .pulsar .client .api .interceptor .ProducerInterceptor ;
3131
32+ import org .springframework .beans .factory .BeanNameAware ;
33+ import org .springframework .beans .factory .ObjectProvider ;
34+ import org .springframework .beans .factory .SmartInitializingSingleton ;
35+ import org .springframework .context .ApplicationContext ;
36+ import org .springframework .context .ApplicationContextAware ;
3237import org .springframework .core .log .LogAccessor ;
38+ import org .springframework .pulsar .observation .DefaultPulsarTemplateObservationConvention ;
39+ import org .springframework .pulsar .observation .PulsarMessageSenderContext ;
40+ import org .springframework .pulsar .observation .PulsarTemplateObservation ;
41+ import org .springframework .pulsar .observation .PulsarTemplateObservationConvention ;
42+
43+ import io .micrometer .observation .Observation ;
44+ import io .micrometer .observation .ObservationRegistry ;
3345
3446/**
3547 * A thread-safe template for executing high-level Pulsar operations.
3951 * @author Chris Bono
4052 * @author Alexander Preuß
4153 */
42- public class PulsarTemplate <T > implements PulsarOperations <T > {
54+ public class PulsarTemplate <T >
55+ implements PulsarOperations <T >, ApplicationContextAware , BeanNameAware , SmartInitializingSingleton {
4356
4457 private final LogAccessor logger = new LogAccessor (LogFactory .getLog (this .getClass ()));
4558
4659 private final PulsarProducerFactory <T > producerFactory ;
4760
4861 private final List <ProducerInterceptor > interceptors ;
4962
63+ private ApplicationContext applicationContext ;
64+
65+ private String beanName ;
66+
5067 private Schema <T > schema ;
5168
69+ private boolean observationEnabled ;
70+
71+ private PulsarTemplateObservationConvention observationConvention ;
72+
73+ private ObservationRegistry observationRegistry ;
74+
5275 /**
5376 * Construct a template instance.
5477 * @param producerFactory the factory used to create the backing Pulsar producers.
@@ -92,14 +115,52 @@ public SendMessageBuilder<T> newMessage(T message) {
92115 return new SendMessageBuilderImpl <>(this , message );
93116 }
94117
118+ @ Override
119+ public void setApplicationContext (ApplicationContext applicationContext ) {
120+ this .applicationContext = applicationContext ;
121+ }
122+
123+ @ Override
124+ public void setBeanName (String beanName ) {
125+ this .beanName = beanName ;
126+ }
127+
95128 /**
96- * Setter for schema.
129+ * Set the schema to use on this template .
97130 * @param schema provides the {@link Schema} used on this template
98131 */
99132 public void setSchema (Schema <T > schema ) {
100133 this .schema = schema ;
101134 }
102135
136+ /**
137+ * Set to true to enable observation via Micrometer.
138+ * @param observationEnabled true to enable.
139+ */
140+ public void setObservationEnabled (boolean observationEnabled ) {
141+ this .observationEnabled = observationEnabled ;
142+ }
143+
144+ /**
145+ * Set a custom observation convention.
146+ * @param observationConvention the convention.
147+ */
148+ public void setObservationConvention (PulsarTemplateObservationConvention observationConvention ) {
149+ this .observationConvention = observationConvention ;
150+ }
151+
152+ @ Override
153+ public void afterSingletonsInstantiated () {
154+ // TODO is this how we want to do this? What about SBAC?
155+ // TODO when would AC be null? Should we assert or at least log the fact if it
156+ // happens?
157+ if (this .observationEnabled && this .observationRegistry == null && this .applicationContext != null ) {
158+ ObjectProvider <ObservationRegistry > registry = this .applicationContext
159+ .getBeanProvider (ObservationRegistry .class );
160+ this .observationRegistry = registry .getIfUnique ();
161+ }
162+ }
163+
103164 private MessageId doSend (String topic , T message , TypedMessageBuilderCustomizer <T > typedMessageBuilderCustomizer ,
104165 MessageRouter messageRouter , ProducerBuilderCustomizer <T > producerCustomizer ) throws PulsarClientException {
105166 try {
@@ -115,22 +176,49 @@ private CompletableFuture<MessageId> doSendAsync(String topic, T message,
115176 ProducerBuilderCustomizer <T > producerCustomizer ) throws PulsarClientException {
116177 final String topicName = ProducerUtils .resolveTopicName (topic , this .producerFactory );
117178 this .logger .trace (() -> String .format ("Sending msg to '%s' topic" , topicName ));
118- final Producer <T > producer = prepareProducerForSend (topic , message , messageRouter , producerCustomizer );
119- TypedMessageBuilder <T > messageBuilder = producer .newMessage ().value (message );
120- if (typedMessageBuilderCustomizer != null ) {
121- typedMessageBuilderCustomizer .customize (messageBuilder );
122- }
123- return messageBuilder .sendAsync ().whenComplete ((msgId , ex ) -> {
124- if (ex == null ) {
125- this .logger .trace (() -> String .format ("Sent msg to '%s' topic" , topicName ));
126- // TODO success metrics
127- }
128- else {
129- this .logger .error (ex , () -> String .format ("Failed to send msg to '%s' topic" , topicName ));
130- // TODO fail metrics
179+
180+ PulsarMessageSenderContext senderContext = PulsarMessageSenderContext .newContext (topicName , this .beanName );
181+ Observation observation = newObservation (senderContext );
182+ try {
183+ observation .start ();
184+ final Producer <T > producer = prepareProducerForSend (topic , message , messageRouter , producerCustomizer );
185+ TypedMessageBuilder <T > messageBuilder = producer .newMessage ().value (message );
186+ if (typedMessageBuilderCustomizer != null ) {
187+ typedMessageBuilderCustomizer .customize (messageBuilder );
131188 }
132- ProducerUtils .closeProducerAsync (producer , this .logger );
133- });
189+ senderContext .properties ().forEach (messageBuilder ::property ); // propagate
190+ // props to
191+ // message
192+ return messageBuilder .sendAsync ().whenComplete ((msgId , ex ) -> {
193+ if (ex == null ) {
194+ this .logger .trace (() -> String .format ("Sent msg to '%s' topic" , topicName ));
195+ observation .stop ();
196+ }
197+ else {
198+ this .logger .error (ex , () -> String .format ("Failed to send msg to '%s' topic" , topicName ));
199+ observation .error (ex );
200+ observation .stop ();
201+ }
202+ ProducerUtils .closeProducerAsync (producer , this .logger );
203+ });
204+ }
205+ catch (RuntimeException ex ) {
206+ observation .error (ex );
207+ observation .stop ();
208+ throw ex ;
209+ }
210+ }
211+
212+ private Observation newObservation (PulsarMessageSenderContext senderContext ) {
213+ Observation observation ;
214+ if (!this .observationEnabled || this .observationRegistry == null ) {
215+ observation = Observation .NOOP ;
216+ }
217+ else {
218+ observation = PulsarTemplateObservation .TEMPLATE_OBSERVATION .observation (this .observationConvention ,
219+ DefaultPulsarTemplateObservationConvention .INSTANCE , senderContext , this .observationRegistry );
220+ }
221+ return observation ;
134222 }
135223
136224 private Producer <T > prepareProducerForSend (String topic , T message , MessageRouter messageRouter ,
0 commit comments