Add instrumentation for rocketmq

instrumentation/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmq/RocketMqTracing.java

@@ -10,7 +10,10 @@
 import org.apache.rocketmq.client.hook.ConsumeMessageHook;
 import org.apache.rocketmq.client.hook.SendMessageHook;
 
+/** Entrypoint for tracing RocketMq producers or consumers. */
 public final class RocketMqTracing {
+
+  /** Returns a new {@link RocketMqTracing} configured with the given {@link OpenTelemetry}. */
   public static RocketMqTracing create(OpenTelemetry openTelemetry) {
     return newBuilder(openTelemetry)
         .setPropagationEnabled(
@@ -23,6 +26,7 @@ public static RocketMqTracing create(OpenTelemetry openTelemetry) {
         .build();
   }
 
+  /** Returns a new {@link RocketMqTracingBuilder} configured with the given {@link OpenTelemetry}. */
   public static RocketMqTracingBuilder newBuilder(OpenTelemetry openTelemetry) {
     return new RocketMqTracingBuilder(openTelemetry);
   }
@@ -46,10 +50,18 @@ public static RocketMqTracingBuilder newBuilder(OpenTelemetry openTelemetry) {
         new RocketMqProducerTracer(openTelemetry, captureExperimentalSpanAttributes);
   }
 
+  /**
+   * Returns a new {@link ConsumeMessageHook} for use with methods like {@link
+   * org.apache.rocketmq.client.impl.consumer.DefaultMQPullConsumerImpl#registerConsumeMessageHook(ConsumeMessageHook)}.
+   */
   public ConsumeMessageHook newTracingConsumeMessageHook() {
     return new TracingConsumeMessageHookImpl(rocketMqConsumerTracer);
   }
 
+  /**
+   * Returns a new {@link SendMessageHook} for use with methods like {@link
+   * org.apache.rocketmq.client.impl.producer.DefaultMQProducerImpl#registerSendMessageHook(SendMessageHook)}.
+   */
   public SendMessageHook newTracingSendMessageHook() {
     return new TracingSendMessageHookImpl(rocketMqProducerTracer, propagationEnabled);
   }

instrumentation/rocketmq-client-4.8/library/src/main/java/io/opentelemetry/instrumentation/rocketmq/RocketMqTracingBuilder.java

@@ -7,6 +7,7 @@
 
 import io.opentelemetry.api.OpenTelemetry;
 
+/** A builder of {@link RocketMqTracing}. */
 public final class RocketMqTracingBuilder {
 
   private final OpenTelemetry openTelemetry;
@@ -18,6 +19,11 @@ public final class RocketMqTracingBuilder {
     this.openTelemetry = openTelemetry;
   }
 
+  /**
+   * Sets whether experimental attributes should be set to spans. These attributes may be changed or
+   * removed in the future, so only enable this if you know you do not require attributes filled by
+   * this instrumentation to be stable across versions
+   */
   public RocketMqTracingBuilder setCaptureExperimentalSpanAttributes(
       boolean captureExperimentalSpanAttributes) {
     this.captureExperimentalSpanAttributes = captureExperimentalSpanAttributes;
@@ -29,6 +35,7 @@ public RocketMqTracingBuilder setPropagationEnabled(boolean propagationEnabled)
     return this;
   }
 
+  /** Returns a new {@link RocketMqTracing} with the settings of this {@link RocketMqTracingBuilder}. */
   public RocketMqTracing build() {
     return new RocketMqTracing(
         openTelemetry, captureExperimentalSpanAttributes, propagationEnabled);