Aerospike client instrumentation

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/build.gradle.kts

@@ -0,0 +1,28 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("com.aerospike")
+    module.set("aerospike-client")
+    versions.set("[4.4.9,)")
+    assertInverse.set(true)
+  }
+}
+
+dependencies {
+  library("com.aerospike:aerospike-client:7.1.0")
+  implementation("io.opentelemetry:opentelemetry-extension-incubator")
+
+  compileOnly("com.google.auto.value:auto-value-annotations")
+  annotationProcessor("com.google.auto.value:auto-value")
+}
+
+tasks {
+  test {
+    jvmArgs("-Djava.net.preferIPv4Stack=true")
+    jvmArgs("-Dotel.instrumentation.aerospike.experimental-span-attributes=true")
+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeClientAttributeExtractor.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import com.aerospike.client.AerospikeException;
+import com.aerospike.client.ResultCode;
+import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor;
+import javax.annotation.Nullable;
+
+final class AerospikeClientAttributeExtractor
+    implements AttributesExtractor<AerospikeRequest, Void> {
+
+  @Override
+  public void onStart(
+      AttributesBuilder attributes, Context parentContext, AerospikeRequest aerospikeRequest) {
+    attributes.put(
+        AerospikeSemanticAttributes.AEROSPIKE_NAMESPACE, aerospikeRequest.getNamespace());
+    attributes.put(AerospikeSemanticAttributes.AEROSPIKE_SET_NAME, aerospikeRequest.getSet());
+    attributes.put(AerospikeSemanticAttributes.AEROSPIKE_USER_KEY, aerospikeRequest.getUserKey());
+  }
+
+  @Override
+  public void onEnd(
+      AttributesBuilder attributes,
+      Context context,
+      AerospikeRequest aerospikeRequest,
+      @Nullable Void unused,
+      @Nullable Throwable error) {
+    attributes.put(
+        AerospikeSemanticAttributes.AEROSPIKE_STATUS, aerospikeRequest.getStatus().name());
+    if (error != null) {
+      if (error instanceof AerospikeException) {
+        AerospikeException aerospikeException = (AerospikeException) error;
+        attributes.put(
+            AerospikeSemanticAttributes.AEROSPIKE_ERROR_CODE, aerospikeException.getResultCode());
+      } else {
+        attributes.put(AerospikeSemanticAttributes.AEROSPIKE_ERROR_CODE, ResultCode.CLIENT_ERROR);
+      }
+    } else {
+      attributes.put(AerospikeSemanticAttributes.AEROSPIKE_ERROR_CODE, ResultCode.OK);
+      if (aerospikeRequest.getSize() != null) {
+        attributes.put(
+            AerospikeSemanticAttributes.AEROSPIKE_TRANSFER_SIZE, aerospikeRequest.getSize());
+      }
+    }
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeClientInstrumentationModule.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static java.util.Arrays.asList;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import java.util.List;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class AerospikeClientInstrumentationModule extends InstrumentationModule {
+
+  public AerospikeClientInstrumentationModule() {
+    super("aerospike-client", "aerospike-client-7.1.0");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("com.aerospike.client.AerospikeClient");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return asList(
+        new SyncCommandInstrumentation(),
+        new SocketInstrumentation(),
+        new AsyncCommandInstrumentation(),
+        new AsyncHandlerInstrumentation(),
+        new AsyncScanAllCommandInstrumentation());
+  }
+
+  @Override
+  public boolean isIndyModule() {
+    return false;
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeDbAttributesGetter.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesGetter;
+import javax.annotation.Nullable;
+
+final class AerospikeDbAttributesGetter implements DbClientAttributesGetter<AerospikeRequest> {
+
+  @Override
+  public String getSystem(AerospikeRequest request) {
+    return AerospikeSemanticAttributes.DbSystemValues.AEROSPIKE;
+  }
+
+  @Override
+  @Nullable
+  public String getUser(AerospikeRequest request) {
+    return null;
+  }
+
+  @Override
+  public String getName(AerospikeRequest request) {
+    return null;
+  }
+
+  @Override
+  public String getConnectionString(AerospikeRequest request) {
+    return null;
+  }
+
+  @Override
+  public String getStatement(AerospikeRequest request) {
+    return null;
+  }
+
+  @Override
+  public String getOperation(AerospikeRequest request) {
+    return request.getOperation();
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeNetworkAttributesGetter.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import com.aerospike.client.cluster.Node;
+import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter;
+import java.net.InetSocketAddress;
+import javax.annotation.Nullable;
+
+final class AerospikeNetworkAttributesGetter
+    implements NetworkAttributesGetter<AerospikeRequest, Void> {
+
+  @Override
+  @Nullable
+  public InetSocketAddress getNetworkPeerInetSocketAddress(
+      AerospikeRequest aerospikeRequest, @Nullable Void unused) {
+    Node node = aerospikeRequest.getNode();
+    if (node != null) {
+      return node.getAddress();
+    }
+    return null;
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeRequest.java

@@ -0,0 +1,60 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import com.aerospike.client.Key;
+import com.aerospike.client.cluster.Node;
+import com.google.auto.value.AutoValue;
+import javax.annotation.Nullable;
+
+@AutoValue
+public abstract class AerospikeRequest {
+  private Node node;
+  private Integer size;
+  private Status status;
+
+  public static AerospikeRequest create(String operation, Key key) {
+    return new AutoValue_AerospikeRequest(
+        operation, key.namespace, key.setName, key.userKey.toString());
+  }
+
+  public static AerospikeRequest create(String operation, String namespace, String set) {
+    return new AutoValue_AerospikeRequest(operation, namespace, set, null);
+  }
+
+  public abstract String getOperation();
+
+  public abstract String getNamespace();
+
+  public abstract String getSet();
+
+  @Nullable
+  public abstract String getUserKey();
+
+  public void setNode(Node node) {
+    this.node = node;
+  }
+
+  public Node getNode() {
+    return this.node;
+  }
+
+  public Integer getSize() {
+    return size;
+  }
+
+  public void setSize(Integer size) {
+    this.size = size;
+  }
+
+  public Status getStatus() {
+    return status;
+  }
+
+  public void setStatus(Status status) {
+    this.status = status;
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeRequestContext.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import io.opentelemetry.context.Context;
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+
+public final class AerospikeRequestContext {
+  private static final ThreadLocal<AerospikeRequestContext> contextThreadLocal =
+      new ThreadLocal<>();
+  private AerospikeRequest request;
+  private Context context;
+
+  private AerospikeRequestContext() {}
+
+  public static AerospikeRequestContext attach(AerospikeRequest request, Context context) {
+
+    AerospikeRequestContext requestContext = new AerospikeRequestContext();
+    requestContext.request = request;
+    requestContext.context = context;
+    contextThreadLocal.set(requestContext);
+    return requestContext;
+  }
+
+  public void detachAndEnd() {
+    contextThreadLocal.remove();
+  }
+
+  @SuppressWarnings("unchecked")
+  public static AerospikeRequestContext current() {
+    return contextThreadLocal.get();
+  }
+
+  public void endSpan(
+      Instrumenter<AerospikeRequest, Void> instrumenter,
+      Context context,
+      AerospikeRequest request,
+      Throwable throwable) {
+    instrumenter.end(context, request, null, throwable);
+  }
+
+  public AerospikeRequest getRequest() {
+    return request;
+  }
+
+  public Context getContext() {
+    return context;
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AerospikeSemanticAttributes.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import static io.opentelemetry.api.common.AttributeKey.longKey;
+import static io.opentelemetry.api.common.AttributeKey.stringKey;
+
+import io.opentelemetry.api.common.AttributeKey;
+
+public final class AerospikeSemanticAttributes {
+  private AerospikeSemanticAttributes() {}
+
+  public static final AttributeKey<String> AEROSPIKE_STATUS = stringKey("aerospike.status");
+  public static final AttributeKey<Long> AEROSPIKE_ERROR_CODE = longKey("aerospike.error.code");
+  public static final AttributeKey<String> AEROSPIKE_NAMESPACE = stringKey("aerospike.namespace");
+  public static final AttributeKey<String> AEROSPIKE_SET_NAME = stringKey("aerospike.set.name");
+  public static final AttributeKey<String> AEROSPIKE_USER_KEY = stringKey("aerospike.user.key");
+  public static final AttributeKey<Long> AEROSPIKE_TRANSFER_SIZE =
+      longKey("aerospike.transfer.size");
+
+  public static final class DbSystemValues {
+    public static final String AEROSPIKE = "aerospike";
+
+    private DbSystemValues() {}
+  }
+}

instrumentation/aerospike-client/aerospike-client-7.1/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/v7_1/AersopikeSingletons.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike.v7_1;
+
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesExtractor;
+import io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientSpanNameExtractor;
+import io.opentelemetry.instrumentation.api.instrumenter.Instrumenter;
+import io.opentelemetry.instrumentation.api.instrumenter.InstrumenterBuilder;
+import io.opentelemetry.instrumentation.api.instrumenter.SpanKindExtractor;
+import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesExtractor;
+import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter;
+import io.opentelemetry.javaagent.bootstrap.internal.InstrumentationConfig;
+import io.opentelemetry.javaagent.instrumentation.aerospike.v7_1.metrics.AerospikeMetrics;
+
+public final class AersopikeSingletons {
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.aerospike-client-7.1";
+
+  private static final Instrumenter<AerospikeRequest, Void> INSTRUMENTER;
+
+  static {
+    AerospikeDbAttributesGetter aerospikeDbAttributesGetter = new AerospikeDbAttributesGetter();
+    NetworkAttributesGetter<AerospikeRequest, Void> netAttributesGetter =
+        new AerospikeNetworkAttributesGetter();
+
+    InstrumenterBuilder<AerospikeRequest, Void> builder =
+        Instrumenter.<AerospikeRequest, Void>builder(
+                GlobalOpenTelemetry.get(),
+                INSTRUMENTATION_NAME,
+                DbClientSpanNameExtractor.create(aerospikeDbAttributesGetter))
+            .addAttributesExtractor(DbClientAttributesExtractor.create(aerospikeDbAttributesGetter))
+            .addAttributesExtractor(NetworkAttributesExtractor.create(netAttributesGetter))
+            .addOperationMetrics(AerospikeMetrics.get());
+    if (InstrumentationConfig.get()
+        .getBoolean("otel.instrumentation.aerospike.experimental-span-attributes", false)) {
+      builder.addAttributesExtractor(new AerospikeClientAttributeExtractor());
+    }
+
+    INSTRUMENTER = builder.buildInstrumenter(SpanKindExtractor.alwaysClient());
+  }
+
+  public static Instrumenter<AerospikeRequest, Void> instrumenter() {
+    return INSTRUMENTER;
+  }
+
+  private AersopikeSingletons() {}
+}