Generate events for OkHttp Websocket events (#863)

cleverchuk · web-flow · commit d1e600e6462e · 2025-03-11T18:18:34.000-07:00
* Generate events for OkHttp Websocket events

* move websocket to separate module and add test
diff --git a/instrumentation/okhttp/okhttp-3.0/agent/build.gradle.kts b/instrumentation/okhttp/okhttp-3.0/agent/build.gradle.kts
@@ -10,7 +10,7 @@ android {
 }
 
 dependencies {
+    compileOnly(libs.okhttp)
     implementation(project(":instrumentation:okhttp:okhttp-3.0:library"))
-    implementation(libs.okhttp)
     implementation(libs.byteBuddy)
 }
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/agent/build.gradle.kts b/instrumentation/okhttp/websocket/okhttp-3.0/agent/build.gradle.kts
@@ -0,0 +1,16 @@
+plugins {
+    id("otel.android-library-conventions")
+    id("otel.publish-conventions")
+}
+
+description = "OpenTelemetry build-time auto-instrumentation for OkHttp Websocket on Android"
+
+android {
+    namespace = "io.opentelemetry.android.okhttp.websocket.agent"
+}
+
+dependencies {
+    implementation(project(":instrumentation:okhttp:websocket:okhttp-3.0:library"))
+    compileOnly(libs.okhttp)
+    implementation(libs.byteBuddy)
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/java/io/opentelemetry/instrumentation/agent/okhttp/v3_0/websocket/OkHttpClientWebsocketAdvice.java b/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/java/io/opentelemetry/instrumentation/agent/okhttp/v3_0/websocket/OkHttpClientWebsocketAdvice.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.agent.okhttp.v3_0.websocket;
+
+import io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal.WebsocketListenerWrapper;
+import net.bytebuddy.asm.Advice;
+import okhttp3.WebSocketListener;
+
+public class OkHttpClientWebsocketAdvice {
+
+    @Advice.OnMethodEnter
+    public static void enter(
+            @Advice.Argument(value = 1, readOnly = false) WebSocketListener webSocketListener) {
+        if (webSocketListener instanceof WebsocketListenerWrapper) return;
+
+        webSocketListener = new WebsocketListenerWrapper(webSocketListener);
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/java/io/opentelemetry/instrumentation/agent/okhttp/v3_0/websocket/OkHttpClientWebsocketPlugin.java b/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/java/io/opentelemetry/instrumentation/agent/okhttp/v3_0/websocket/OkHttpClientWebsocketPlugin.java
@@ -0,0 +1,40 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.agent.okhttp.v3_0.websocket;
+
+import static net.bytebuddy.matcher.ElementMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+
+import java.io.IOException;
+import net.bytebuddy.asm.Advice;
+import net.bytebuddy.build.Plugin;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.dynamic.ClassFileLocator;
+import net.bytebuddy.dynamic.DynamicType;
+import okhttp3.WebSocketListener;
+
+public class OkHttpClientWebsocketPlugin implements Plugin {
+
+    @Override
+    public DynamicType.Builder<?> apply(
+            DynamicType.Builder<?> builder,
+            TypeDescription typeDescription,
+            ClassFileLocator classFileLocator) {
+        return builder.visit(
+                Advice.to(OkHttpClientWebsocketAdvice.class)
+                        .on(named("newWebSocket").and(takesArgument(1, WebSocketListener.class))));
+    }
+
+    @Override
+    public void close() throws IOException {
+        // No operation.
+    }
+
+    @Override
+    public boolean matches(TypeDescription target) {
+        return target.getTypeName().equals("okhttp3.OkHttpClient");
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/resources/META-INF/net.bytebuddy/build.plugins b/instrumentation/okhttp/websocket/okhttp-3.0/agent/src/main/resources/META-INF/net.bytebuddy/build.plugins
@@ -0,0 +1 @@
+io.opentelemetry.instrumentation.agent.okhttp.v3_0.websocket.OkHttpClientWebsocketPlugin
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/build.gradle.kts b/instrumentation/okhttp/websocket/okhttp-3.0/library/build.gradle.kts
@@ -0,0 +1,22 @@
+plugins {
+    id("otel.android-library-conventions")
+    id("otel.publish-conventions")
+}
+
+description = "OpenTelemetry OkHttp Websocket library instrumentation for Android"
+
+android {
+    namespace = "io.opentelemetry.android.okhttp.websocket.library"
+
+    defaultConfig {
+        consumerProguardFiles("consumer-rules.pro")
+    }
+}
+
+dependencies {
+    api(project(":instrumentation:android-instrumentation"))
+    compileOnly(libs.okhttp)
+    api(libs.opentelemetry.instrumentation.okhttp)
+    implementation(libs.opentelemetry.instrumentation.apiSemconv)
+    implementation(libs.opentelemetry.api.incubator)
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/consumer-rules.pro b/instrumentation/okhttp/websocket/okhttp-3.0/library/consumer-rules.pro
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/OkHttpWebsocketInstrumentation.java b/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/OkHttpWebsocketInstrumentation.java
@@ -0,0 +1,19 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal;
+
+import androidx.annotation.NonNull;
+import com.google.auto.service.AutoService;
+import io.opentelemetry.android.instrumentation.AndroidInstrumentation;
+import io.opentelemetry.android.instrumentation.InstallationContext;
+
+@AutoService(AndroidInstrumentation.class)
+public class OkHttpWebsocketInstrumentation implements AndroidInstrumentation {
+    @Override
+    public void install(@NonNull InstallationContext ctx) {
+        WebsocketEventGenerator.configure(ctx);
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketAttributeExtractor.java b/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketAttributeExtractor.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal;
+
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.common.AttributesBuilder;
+import io.opentelemetry.semconv.HttpAttributes;
+import io.opentelemetry.semconv.NetworkAttributes;
+import io.opentelemetry.semconv.UrlAttributes;
+import okhttp3.Request;
+import okhttp3.WebSocket;
+
+class WebsocketAttributeExtractor {
+    private WebsocketAttributeExtractor() {}
+
+    static Attributes extractAttributes(WebSocket socket) {
+        AttributesBuilder builder = Attributes.builder();
+        Request request = socket.request();
+        builder.put(NetworkAttributes.NETWORK_PROTOCOL_NAME, "websocket");
+
+        builder.put(HttpAttributes.HTTP_REQUEST_METHOD, request.method());
+        builder.put(UrlAttributes.URL_FULL, request.url().toString());
+        builder.put(NetworkAttributes.NETWORK_PEER_PORT, request.url().port());
+
+        return builder.build();
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketAttributes.java b/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketAttributes.java
@@ -0,0 +1,16 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal;
+
+import io.opentelemetry.api.common.AttributeKey;
+
+public class WebsocketAttributes {
+    private WebsocketAttributes() {}
+
+    public static AttributeKey<Long> MESSAGE_SIZE = AttributeKey.longKey("websocket.message.size");
+    public static AttributeKey<String> MESSAGE_TYPE =
+            AttributeKey.stringKey("websocket.message.type");
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketEventGenerator.java b/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketEventGenerator.java
@@ -0,0 +1,33 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal;
+
+import io.opentelemetry.android.instrumentation.InstallationContext;
+import io.opentelemetry.api.OpenTelemetry;
+import io.opentelemetry.api.common.Attributes;
+import io.opentelemetry.api.incubator.logs.ExtendedLogRecordBuilder;
+import io.opentelemetry.api.incubator.logs.ExtendedLogger;
+
+public final class WebsocketEventGenerator {
+
+    private WebsocketEventGenerator() {}
+
+    private static final String SCOPE = "io.opentelemetry.websocket.events";
+
+    private static ExtendedLogger logger =
+            (ExtendedLogger) OpenTelemetry.noop().getLogsBridge().loggerBuilder(SCOPE).build();
+
+    public static void configure(InstallationContext context) {
+        WebsocketEventGenerator.logger =
+                (ExtendedLogger)
+                        context.getOpenTelemetry().getLogsBridge().loggerBuilder(SCOPE).build();
+    }
+
+    public static void generateEvent(String eventName, Attributes attributes) {
+        ExtendedLogRecordBuilder logRecordBuilder = logger.logRecordBuilder();
+        logRecordBuilder.setEventName(eventName).setAllAttributes(attributes).emit();
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketListenerWrapper.java b/instrumentation/okhttp/websocket/okhttp-3.0/library/src/main/java/io/opentelemetry/instrumentation/library/okhttp/v3_0/websocket/internal/WebsocketListenerWrapper.java
@@ -0,0 +1,68 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.library.okhttp.v3_0.websocket.internal;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import io.opentelemetry.api.common.Attributes;
+import okhttp3.Response;
+import okhttp3.WebSocket;
+import okhttp3.WebSocketListener;
+import okio.ByteString;
+
+public class WebsocketListenerWrapper extends WebSocketListener {
+    private final WebSocketListener delegate;
+
+    public WebsocketListenerWrapper(WebSocketListener delegate) {
+        this.delegate = delegate;
+    }
+
+    @Override
+    public void onClosed(@NonNull WebSocket webSocket, int code, @NonNull String reason) {
+        Attributes attributes = WebsocketAttributeExtractor.extractAttributes(webSocket);
+        WebsocketEventGenerator.generateEvent("websocket.close", attributes);
+        delegate.onClosed(webSocket, code, reason);
+    }
+
+    @Override
+    public void onOpen(@NonNull WebSocket webSocket, @NonNull Response response) {
+        Attributes attributes = WebsocketAttributeExtractor.extractAttributes(webSocket);
+        WebsocketEventGenerator.generateEvent("websocket.open", attributes);
+        delegate.onOpen(webSocket, response);
+    }
+
+    @Override
+    public void onMessage(@NonNull WebSocket webSocket, @NonNull String text) {
+        Attributes attributes = WebsocketAttributeExtractor.extractAttributes(webSocket);
+        WebsocketEventGenerator.generateEvent(
+                "websocket.message",
+                attributes.toBuilder()
+                        .put(WebsocketAttributes.MESSAGE_TYPE, "text")
+                        .put(WebsocketAttributes.MESSAGE_SIZE, text.length())
+                        .build());
+        delegate.onMessage(webSocket, text);
+    }
+
+    @Override
+    public void onMessage(@NonNull WebSocket webSocket, @NonNull ByteString bytes) {
+        Attributes attributes = WebsocketAttributeExtractor.extractAttributes(webSocket);
+        WebsocketEventGenerator.generateEvent(
+                "websocket.message",
+                attributes.toBuilder()
+                        .put(WebsocketAttributes.MESSAGE_TYPE, "bytes")
+                        .put(WebsocketAttributes.MESSAGE_SIZE, bytes.size())
+                        .build());
+        delegate.onMessage(webSocket, bytes);
+    }
+
+    @Override
+    public void onFailure(
+            @NonNull WebSocket webSocket, @NonNull Throwable t, @Nullable Response response) {
+        Attributes attributes = WebsocketAttributeExtractor.extractAttributes(webSocket);
+        WebsocketEventGenerator.generateEvent("websocket.error", attributes);
+        delegate.onFailure(webSocket, t, response);
+    }
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/testing/build.gradle.kts b/instrumentation/okhttp/websocket/okhttp-3.0/testing/build.gradle.kts
@@ -0,0 +1,18 @@
+plugins {
+    id("otel.android-app-conventions")
+    id("net.bytebuddy.byte-buddy-gradle-plugin")
+}
+
+android {
+    namespace = "io.opentelemetry.android.okhttp.websocket.testing"
+}
+
+dependencies {
+    implementation(project(":test-common"))
+    byteBuddy(project(":instrumentation:okhttp:websocket:okhttp-3.0:agent"))
+    implementation(project(":instrumentation:okhttp:websocket:okhttp-3.0:library"))
+
+    implementation(libs.okhttp)
+    implementation(libs.opentelemetry.exporter.otlp)
+    androidTestImplementation(libs.okhttp.mockwebserver)
+}
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/testing/src/androidTest/java/io/opentelemetry/instrumentation/library/okhttp/websocket/v3_0/InstrumentationTest.java b/instrumentation/okhttp/websocket/okhttp-3.0/testing/src/androidTest/java/io/opentelemetry/instrumentation/library/okhttp/websocket/v3_0/InstrumentationTest.java
diff --git a/instrumentation/okhttp/websocket/okhttp-3.0/testing/src/main/AndroidManifest.xml b/instrumentation/okhttp/websocket/okhttp-3.0/testing/src/main/AndroidManifest.xml
diff --git a/settings.gradle.kts b/settings.gradle.kts
diff --git a/test-common/src/main/kotlin/io/opentelemetry/android/test/common/OpenTelemetryRumRule.kt b/test-common/src/main/kotlin/io/opentelemetry/android/test/common/OpenTelemetryRumRule.kt

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ android {`
`10`	`10`	`}`
`11`	`11`
`12`	`12`	`dependencies {`
	`13`	`+ compileOnly(libs.okhttp)`
`13`	`14`	`implementation(project(":instrumentation:okhttp:okhttp-3.0:library"))`
`14`		`- implementation(libs.okhttp)`
`15`	`15`	`implementation(libs.byteBuddy)`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+io.opentelemetry.instrumentation.agent.okhttp.v3_0.websocket.OkHttpClientWebsocketPlugin`