Interface ObservationCollector

All Known Implementing Classes:

NoOpObservationCollector

public interface ObservationCollector

API to instrument operations in the AMQP client. The supported operations are publishing, asynchronous delivery, and synchronous delivery (basic.get).

Implementations can gather information and send it to tracing backends. This allows e.g. following the processing steps of a given message through different systems.

This is considered an SPI and is susceptible to change at any time.

Since:

5.19.0

See Also:

• ConnectionFactory.setObservationCollector(ObservationCollector)
• invalid reference

  com.rabbitmq.client.observation.micrometer.MicrometerObservationCollectorBuilder

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ObservationCollector.BasicGetCall	Underlying basic.get call.
static interface	ObservationCollector.ConnectionInfo	Connection information.
static interface	ObservationCollector.PublishCall	Underlying publishing call.

Field Summary

Fields

Modifier and Type	Field	Description
static final ObservationCollector	NO_OP

Method Summary

Modifier and Type	Method	Description
Consumer	basicConsume(String queue, String consumerTag, Consumer consumer)	Decorate consumer registration.
GetResponse	basicGet(ObservationCollector.BasicGetCall call, String queue)	Decorate message polling with basic.get.
void	publish(ObservationCollector.PublishCall call, AMQP.Basic.Publish publish, AMQP.BasicProperties properties, byte[] body, ObservationCollector.ConnectionInfo connectionInfo)	Decorate message publishing.

Field Details

NO_OP

static final ObservationCollector NO_OP

Method Details

publish

void publish(ObservationCollector.PublishCall call,
 AMQP.Basic.Publish publish,
 AMQP.BasicProperties properties,
 byte[] body,
 ObservationCollector.ConnectionInfo connectionInfo)
      throws IOException

Decorate message publishing.

Implementations are expected to call

invalid reference

PublishCall#publish(PublishCall, AMQP.Basic.Publish, AMQP.BasicProperties, byte[], ConnectionInfo)

to make sure the message is actually sent.

Parameters:

call -

publish -

properties -

body -

connectionInfo -

Throws:

IOException

basicConsume

Consumer basicConsume(String queue,
 String consumerTag,
 Consumer consumer)

Decorate consumer registration.

Implementations are expected to decorate the appropriate Consumer callbacks. The original Consumer behavior should not be changed though.

Parameters:

queue -

consumerTag -

consumer -

Returns:

basicGet

GetResponse basicGet(ObservationCollector.BasicGetCall call,
 String queue)

Decorate message polling with basic.get.

Implementations are expected to

invalid reference

BasicGetCall#basicGet(BasicGetCall, String)

and return the same result.

Parameters:

call -

queue -

Returns: