Aerospike client instrumentation

docs/supported-libraries.md

@@ -19,6 +19,7 @@ These are the supported libraries and frameworks:
 
 | Library/Framework                                                                                                                           | Auto-instrumented versions         | Standalone Library Instrumentation [1]                                                                                                                                                                                                                                                                                                                                                  | Semantic Conventions                                                                                                                    |
 |---------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
+| [Aerospike Client](https://github.com/aerospike/aerospike-client-java)                                                                      | 7.1+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [Database Pool Metrics]                                                                                                                  |
 | [Akka Actors](https://doc.akka.io/docs/akka/current/typed/index.html)                                                                       | 2.3+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                     |
 | [Akka HTTP](https://doc.akka.io/docs/akka-http/current/index.html)                                                                          | 10.0+                              | N/A                                                                                                                                                                                                                                                                                                                                                                                     | [HTTP Client Spans], [HTTP Client Metrics], [HTTP Server Spans], [HTTP Server Metrics], Provides `http.route` [2]                       |
 | [Alibaba Druid](https://github.com/alibaba/druid)                                                                                           | 1.0+                               | [opentelemetry-alibaba-druid-1.0](../instrumentation/alibaba-druid-1.0/library)                                                                                                                                                                                                                                                                                                         | [Database Pool Metrics]                                                                                                                 |

instrumentation/aerospike-client/README.md

@@ -0,0 +1,6 @@
+# Settings for the Aerospike-Client instrumentation
+
+| System property                                               | Type    | Default | Description                                                          |
+|---------------------------------------------------------------|---------|---------|----------------------------------------------------------------------|
+| `otel.instrumentation.aerospike.experimental-span-attributes` | Boolean | `false` | Enable the capture of experimental Aerospike client span attributes. |
+| `otel.instrumentation.aerospike.experimental-metrics`         | Boolean | `false` | Enable the recording of experimental Aerospike client metrics.       |

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

@@ -0,0 +1,37 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("com.aerospike")
+    module.set("aerospike-client")
+    versions.set("[7.1.0,)")
+    assertInverse.set(true)
+  }
+}
+
+val latestDepTest = findProperty("testLatestDeps") as Boolean
+
+dependencies {
+  library("com.aerospike:aerospike-client:7.1.0")
+  implementation("io.opentelemetry:opentelemetry-api-incubator")
+
+  compileOnly("com.google.auto.value:auto-value-annotations")
+  annotationProcessor("com.google.auto.value:auto-value")
+}
+
+if (latestDepTest) {
+  otelJava {
+    minJavaVersionSupported.set(JavaVersion.VERSION_21)
+  }
+}
+
+tasks {
+  test {
+    jvmArgs("-Djava.net.preferIPv4Stack=true")
+    jvmArgs("-Dotel.instrumentation.aerospike.experimental-span-attributes=true")
+    jvmArgs("-Dotel.instrumentation.aerospike.experimental-metrics=true")
+    usesService(gradle.sharedServices.registrations["testcontainersBuildService"].service)
+  }
+}

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

@@ -0,0 +1,50 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike;
+
+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 io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeRequest;
+import io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeSemanticAttributes;
+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_SET_NAME, aerospikeRequest.getSet());
+  }
+
+  @Override
+  public void onEnd(
+      AttributesBuilder attributes,
+      Context context,
+      AerospikeRequest aerospikeRequest,
+      @Nullable Void unused,
+      @Nullable Throwable error) {
+    if (aerospikeRequest.getNode() != null) {
+      String nodeName = aerospikeRequest.getNode().getName();
+      attributes.put(AerospikeSemanticAttributes.AEROSPIKE_NODE_NAME, nodeName);
+    }
+
+    if (error != null) {
+      if (error instanceof AerospikeException) {
+        AerospikeException aerospikeException = (AerospikeException) error;
+        attributes.put(
+            AerospikeSemanticAttributes.AEROSPIKE_STATUS, aerospikeException.getResultCode());
+      } else {
+        attributes.put(AerospikeSemanticAttributes.AEROSPIKE_STATUS, ResultCode.CLIENT_ERROR);
+      }
+    } else {
+      attributes.put(AerospikeSemanticAttributes.AEROSPIKE_STATUS, ResultCode.OK);
+    }
+  }
+}

instrumentation/aerospike-client/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/AerospikeClientInstrumentation.java

@@ -0,0 +1,128 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike;
+
+import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
+import static io.opentelemetry.javaagent.instrumentation.aerospike.AerospikeSingletons.instrumenter;
+import static io.opentelemetry.javaagent.instrumentation.aerospike.internal.CustomElementMatcher.iterableHasAtLeastOne;
+import static net.bytebuddy.matcher.ElementMatchers.hasSuperType;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.not;
+import static net.bytebuddy.matcher.ElementMatchers.takesGenericArguments;
+
+import com.aerospike.client.Key;
+import io.opentelemetry.context.Context;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeRequest;
+import io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeRequestContext;
+import java.util.Locale;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+public class AerospikeClientInstrumentation implements TypeInstrumentation {
+
+  @Override
+  public ElementMatcher<TypeDescription> typeMatcher() {
+    return hasSuperType(named("com.aerospike.client.IAerospikeClient"));
+  }
+
+  @Override
+  public void transform(TypeTransformer transformer) {
+    transformer.applyAdviceToMethod(
+        isMethod()
+            .and(takesGenericArguments(iterableHasAtLeastOne(named("com.aerospike.client.Key"))))
+            .and(
+                not(
+                    takesGenericArguments(
+                        iterableHasAtLeastOne(named("com.aerospike.client.async.EventLoop"))))),
+        this.getClass().getName() + "$SyncCommandAdvice");
+
+    transformer.applyAdviceToMethod(
+        isMethod()
+            .and(takesGenericArguments(iterableHasAtLeastOne(named("com.aerospike.client.Key"))))
+            .and(
+                takesGenericArguments(
+                    iterableHasAtLeastOne(named("com.aerospike.client.async.EventLoop")))),
+        this.getClass().getName() + "$AsyncCommandAdvice");
+  }
+
+  @SuppressWarnings("unused")
+  public static class SyncCommandAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void startInstrumentation(
+        @Advice.Origin("#m") String methodName,
+        @Advice.AllArguments Object[] args,
+        @Advice.Local("AerospikeContext") AerospikeRequestContext requestContext) {
+      Key key = null;
+      for (Object object : args) {
+        if (object instanceof Key) {
+          key = (Key) object;
+        }
+      }
+      if (key == null) {
+        return;
+      }
+      Context parentContext = currentContext();
+      AerospikeRequest request =
+          AerospikeRequest.create(methodName.toUpperCase(Locale.ROOT), key.namespace, key.setName);
+      if (!instrumenter().shouldStart(parentContext, request)) {
+        return;
+      }
+      Context context = instrumenter().start(parentContext, request);
+      requestContext = AerospikeRequestContext.attach(request, context);
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void stopInstrumentation(
+        @Advice.Thrown Throwable ex,
+        @Advice.Local("AerospikeContext") AerospikeRequestContext requestContext) {
+      requestContext.setThrowable(ex);
+      requestContext.detachAndEnd();
+    }
+  }
+
+  @SuppressWarnings("unused")
+  public static class AsyncCommandAdvice {
+
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void startInstrumentation(
+        @Advice.Origin("#m") String methodName,
+        @Advice.AllArguments Object[] args,
+        @Advice.Local("AerospikeContext") AerospikeRequestContext requestContext) {
+      Key key = null;
+      for (Object object : args) {
+        if (object instanceof Key) {
+          key = (Key) object;
+        }
+      }
+      if (key == null) {
+        return;
+      }
+      Context parentContext = currentContext();
+      AerospikeRequest request =
+          AerospikeRequest.create(methodName.toUpperCase(Locale.ROOT), key.namespace, key.setName);
+      if (!instrumenter().shouldStart(parentContext, request)) {
+        return;
+      }
+      Context context = instrumenter().start(parentContext, request);
+      requestContext = AerospikeRequestContext.attach(request, context);
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void stopInstrumentaionIfError(
+        @Advice.Thrown Throwable ex,
+        @Advice.Local("AerospikeContext") AerospikeRequestContext requestContext) {
+      if (ex != null) {
+        requestContext.setThrowable(ex);
+        requestContext.detachAndEnd();
+      }
+    }
+  }
+}

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

@@ -0,0 +1,36 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike;
+
+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");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("com.aerospike.client.metrics.LatencyType");
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return asList(
+        new AerospikeClientInstrumentation(),
+        new SyncCommandInstrumentation(),
+        new AsyncCommandInstrumentation());
+  }
+}

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

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

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

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike;
+
+import com.aerospike.client.cluster.Node;
+import io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter;
+import io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeRequest;
+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/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/aerospike/AerospikeSingletons.java

@@ -0,0 +1,56 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.aerospike;
+
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.config.internal.InstrumentationConfig;
+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.AgentInstrumentationConfig;
+import io.opentelemetry.javaagent.instrumentation.aerospike.internal.AerospikeRequest;
+import io.opentelemetry.javaagent.instrumentation.aerospike.metrics.AerospikeMetrics;
+
+public final class AerospikeSingletons {
+  private static final String INSTRUMENTATION_NAME = "io.opentelemetry.aerospike-client";
+
+  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));
+    InstrumentationConfig instrumentationConfig = AgentInstrumentationConfig.get();
+    if (instrumentationConfig.getBoolean(
+        "otel.instrumentation.aerospike.experimental-span-attributes", false)) {
+      builder.addAttributesExtractor(new AerospikeClientAttributeExtractor());
+    }
+    if (instrumentationConfig.getBoolean(
+        "otel.instrumentation.aerospike.experimental-metrics", false)) {
+      builder.addOperationMetrics(AerospikeMetrics.get());
+    }
+
+    INSTRUMENTER = builder.buildInstrumenter(SpanKindExtractor.alwaysClient());
+  }
+
+  public static Instrumenter<AerospikeRequest, Void> instrumenter() {
+    return INSTRUMENTER;
+  }
+
+  private AerospikeSingletons() {}
+}