Instrumentation API part 2 (open-telemetry#408) (open-telemetry#416)

* Moving network provider tools to services * Moving network service related tests * Moving network attr init feature to the agent * Making network instrumentation depend on the agent * Initializing CurrentNetworkProvider as service * Clean up config * Created NetworkChangeInstrumentation * Updated network monitor tests * Clean up * Renaming installOn by start * Adding internal class docs * Fixing visible for tests comment * Rename .java to .kt * Removing Carrier.Builder
corabank · Jun 14, 2024 · 99f3189 · 99f3189
1 parent 519aa6f
commit 99f3189
Show file tree

Hide file tree

Showing 35 changed files with 330 additions and 417 deletions.
diff --git a/android-agent/build.gradle.kts b/android-agent/build.gradle.kts
@@ -67,7 +67,6 @@ dependencies {
     implementation(project(":instrumentation:anr"))
     implementation(project(":instrumentation:common-api"))
     implementation(project(":instrumentation:crash"))
-    implementation(project(":instrumentation:network"))
     implementation(project(":instrumentation:slowrendering"))
     implementation(libs.androidx.core)
     implementation(libs.androidx.navigation.fragment)

diff --git a/android-agent/src/main/AndroidManifest.xml b/android-agent/src/main/AndroidManifest.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
     <uses-permission android:name="android.permission.INTERNET" />
     <uses-permission android:name="android.permission.READ_PHONE_STATE" />
 

diff --git a/android-agent/src/main/java/io/opentelemetry/android/OpenTelemetryRumBuilder.java b/android-agent/src/main/java/io/opentelemetry/android/OpenTelemetryRumBuilder.java
@@ -22,12 +22,10 @@
 import io.opentelemetry.android.instrumentation.common.InstrumentedApplication;
 import io.opentelemetry.android.instrumentation.crash.CrashReporter;
 import io.opentelemetry.android.instrumentation.crash.CrashReporterBuilder;
-import io.opentelemetry.android.instrumentation.network.CurrentNetworkProvider;
-import io.opentelemetry.android.instrumentation.network.NetworkAttributesSpanAppender;
-import io.opentelemetry.android.instrumentation.network.NetworkChangeMonitor;
 import io.opentelemetry.android.instrumentation.slowrendering.SlowRenderingDetector;
 import io.opentelemetry.android.instrumentation.startup.InitializationEvents;
 import io.opentelemetry.android.instrumentation.startup.SdkInitializationEvents;
+import io.opentelemetry.android.internal.features.networkattrs.NetworkAttributesSpanAppender;
 import io.opentelemetry.android.internal.features.persistence.DiskManager;
 import io.opentelemetry.android.internal.features.persistence.SimpleTemporaryFileProvider;
 import io.opentelemetry.android.internal.processors.GlobalAttributesLogRecordAppender;
@@ -100,7 +98,6 @@ public final class OpenTelemetryRumBuilder {
             (a) -> a;
 
     private Resource resource;
-    @Nullable private CurrentNetworkProvider currentNetworkProvider = null;
     private InitializationEvents initializationEvents = InitializationEvents.NO_OP;
     private Consumer<AnrDetectorBuilder> anrCustomizer = x -> {};
     private Consumer<CrashReporterBuilder> crashReporterCustomizer = x -> {};
@@ -130,18 +127,6 @@ public OpenTelemetryRumBuilder setResource(Resource resource) {
         return this;
     }
 
-    /**
-     * Call this to pass an existing CurrentNetworkProvider instance to share with the underlying
-     * OpenTelemetry Rum instrumentation.
-     *
-     * @return {@code this}
-     */
-    public OpenTelemetryRumBuilder setCurrentNetworkProvider(
-            CurrentNetworkProvider currentNetworkProvider) {
-        this.currentNetworkProvider = currentNetworkProvider;
-        return this;
-    }
-
     /**
      * Merges a new {@link Resource} with any existing {@link Resource} in this builder. The
      * resulting {@link Resource} will be attached to all telemetry emitted by the {@link
@@ -455,27 +440,17 @@ private void applyConfiguration() {
         // Network specific attributes
         if (config.shouldIncludeNetworkAttributes()) {
             // Add span processor that appends network attributes.
-            CurrentNetworkProvider currentNetworkProvider = getOrCreateCurrentNetworkProvider();
             addTracerProviderCustomizer(
                     (tracerProviderBuilder, app) -> {
                         SpanProcessor networkAttributesSpanAppender =
-                                NetworkAttributesSpanAppender.create(currentNetworkProvider);
+                                NetworkAttributesSpanAppender.create(
+                                        ServiceManager.get().getCurrentNetworkProvider());
                         return tracerProviderBuilder.addSpanProcessor(
                                 networkAttributesSpanAppender);
                     });
             initializationEvents.currentNetworkProviderInitialized();
         }
 
-        // Add network change monitor if enabled (default = = true)
-        if (config.isNetworkChangeMonitoringEnabled()) {
-            addInstrumentation(
-                    app -> {
-                        NetworkChangeMonitor.create(getOrCreateCurrentNetworkProvider())
-                                .installOn(app);
-                        initializationEvents.networkMonitorInitialized();
-                    });
-        }
-
         // Add span processor that appends screen attribute(s)
         if (config.shouldIncludeScreenAttributes()) {
             addTracerProviderCustomizer(
@@ -530,13 +505,6 @@ private void applyConfiguration() {
         }
     }
 
-    private CurrentNetworkProvider getOrCreateCurrentNetworkProvider() {
-        if (currentNetworkProvider == null) {
-            this.currentNetworkProvider = CurrentNetworkProvider.createAndStart(application);
-        }
-        return currentNetworkProvider;
-    }
-
     private SdkTracerProvider buildTracerProvider(
             SessionId sessionId, Application application, SpanExporter spanExporter) {
         SdkTracerProviderBuilder tracerProviderBuilder =

diff --git a/android-agent/src/main/java/io/opentelemetry/android/config/OtelRumConfig.java b/android-agent/src/main/java/io/opentelemetry/android/config/OtelRumConfig.java
@@ -7,7 +7,7 @@
 
 import io.opentelemetry.android.ScreenAttributesSpanProcessor;
 import io.opentelemetry.android.features.diskbuffering.DiskBufferingConfiguration;
-import io.opentelemetry.android.instrumentation.network.CurrentNetworkProvider;
+import io.opentelemetry.android.internal.services.network.CurrentNetworkProvider;
 import io.opentelemetry.api.common.Attributes;
 import java.time.Duration;
 import java.util.function.Supplier;
@@ -28,7 +28,6 @@ public class OtelRumConfig {
     private boolean includeScreenAttributes = true;
     private DiskBufferingConfiguration diskBufferingConfiguration =
             DiskBufferingConfiguration.builder().build();
-    private boolean networkChangeMonitoringEnabled = true;
     private boolean anrDetectionEnabled = true;
     private boolean slowRenderingDetectionEnabled = true;
     private Duration slowRenderingDetectionPollInterval =
@@ -121,20 +120,6 @@ public OtelRumConfig setDiskBufferingConfiguration(
         return this;
     }
 
-    /**
-     * Sets the configuration so that network change monitoring, which is enabled by default, will
-     * not be started.
-     */
-    public OtelRumConfig disableNetworkChangeMonitoring() {
-        networkChangeMonitoringEnabled = false;
-        return this;
-    }
-
-    /** Returns true if network change monitoring is enabled (default = true). */
-    public boolean isNetworkChangeMonitoringEnabled() {
-        return networkChangeMonitoringEnabled;
-    }
-
     /** Returns true if ANR (application not responding) detection is enabled (default = true). */
     public boolean isAnrDetectionEnabled() {
         return anrDetectionEnabled;

diff --git a/...rk/CurrentNetworkAttributesExtractor.java → ...rs/CurrentNetworkAttributesExtractor.java b/...rk/CurrentNetworkAttributesExtractor.java → ...rs/CurrentNetworkAttributesExtractor.java
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.android.instrumentation.network;
+package io.opentelemetry.android.internal.features.networkattrs;
 
 import static io.opentelemetry.semconv.incubating.NetworkIncubatingAttributes.NETWORK_CARRIER_ICC;
 import static io.opentelemetry.semconv.incubating.NetworkIncubatingAttributes.NETWORK_CARRIER_MCC;
@@ -13,13 +13,14 @@
 import static io.opentelemetry.semconv.incubating.NetworkIncubatingAttributes.NETWORK_CONNECTION_TYPE;
 
 import androidx.annotation.Nullable;
+import io.opentelemetry.android.internal.services.network.data.CurrentNetwork;
 import io.opentelemetry.api.common.AttributeKey;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
 
-final class CurrentNetworkAttributesExtractor {
+public final class CurrentNetworkAttributesExtractor {
 
-    Attributes extract(CurrentNetwork network) {
+    public Attributes extract(CurrentNetwork network) {
         AttributesBuilder builder =
                 Attributes.builder()
                         .put(NETWORK_CONNECTION_TYPE, network.getState().getHumanName());

diff --git a/...etwork/NetworkAttributesSpanAppender.java → ...kattrs/NetworkAttributesSpanAppender.java b/...etwork/NetworkAttributesSpanAppender.java → ...kattrs/NetworkAttributesSpanAppender.java
@@ -3,8 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-package io.opentelemetry.android.instrumentation.network;
+package io.opentelemetry.android.internal.features.networkattrs;
 
+import io.opentelemetry.android.internal.services.network.CurrentNetworkProvider;
+import io.opentelemetry.android.internal.services.network.data.CurrentNetwork;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.context.Context;
 import io.opentelemetry.sdk.trace.ReadWriteSpan;

diff --git a/android-agent/src/main/java/io/opentelemetry/android/internal/services/ServiceManager.kt b/android-agent/src/main/java/io/opentelemetry/android/internal/services/ServiceManager.kt
@@ -5,7 +5,8 @@
 
 package io.opentelemetry.android.internal.services
 
-import android.content.Context
+import android.app.Application
+import io.opentelemetry.android.internal.services.network.CurrentNetworkProvider
 import io.opentelemetry.android.internal.services.periodicwork.PeriodicWorkService
 
 /**
@@ -18,22 +19,25 @@ interface ServiceManager : Startable {
 
     fun getPeriodicWorkService(): PeriodicWorkService
 
+    fun getCurrentNetworkProvider(): CurrentNetworkProvider
+
     companion object {
         private var instance: ServiceManager? = null
 
         @JvmStatic
-        fun initialize(appContext: Context) {
+        fun initialize(application: Application) {
             if (instance != null) {
                 return
             }
             instance =
                 ServiceManagerImpl(
                     listOf(
-                        Preferences.create(appContext),
+                        Preferences.create(application),
                         CacheStorage(
-                            appContext,
+                            application,
                         ),
                         PeriodicWorkService(),
+                        CurrentNetworkProvider.create(application),
                     ),
                 )
         }

diff --git a/android-agent/src/main/java/io/opentelemetry/android/internal/services/ServiceManagerImpl.kt b/android-agent/src/main/java/io/opentelemetry/android/internal/services/ServiceManagerImpl.kt
@@ -5,6 +5,7 @@
 
 package io.opentelemetry.android.internal.services
 
+import io.opentelemetry.android.internal.services.network.CurrentNetworkProvider
 import io.opentelemetry.android.internal.services.periodicwork.PeriodicWorkService
 import java.util.Collections
 
@@ -31,6 +32,10 @@ internal class ServiceManagerImpl(services: List<Any>) : ServiceManager {
         return getService(PeriodicWorkService::class.java)
     }
 
+    override fun getCurrentNetworkProvider(): CurrentNetworkProvider {
+        return getService(CurrentNetworkProvider::class.java)
+    }
+
     override fun start() {
         for (service in services.values) {
             if (service is Startable) {

diff --git a/...agent/src/main/java/io/opentelemetry/android/internal/services/network/CarrierFinder.java b/...agent/src/main/java/io/opentelemetry/android/internal/services/network/CarrierFinder.java
@@ -0,0 +1,50 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.android.internal.services.network;
+
+import android.os.Build;
+import android.telephony.TelephonyManager;
+import androidx.annotation.RequiresApi;
+import io.opentelemetry.android.internal.services.network.data.Carrier;
+
+/**
+ * This class is internal and not for public use. Its APIs are unstable and can change at any time.
+ */
+@RequiresApi(api = Build.VERSION_CODES.P)
+public class CarrierFinder {
+
+    private final TelephonyManager telephonyManager;
+
+    public CarrierFinder(TelephonyManager telephonyManager) {
+        this.telephonyManager = telephonyManager;
+    }
+
+    public Carrier get() {
+        int id = telephonyManager.getSimCarrierId();
+        String name = null;
+        String mobileCountryCode = null;
+        String mobileNetworkCode = null;
+        String isoCountryCode = null;
+        CharSequence simCarrierIdName = telephonyManager.getSimCarrierIdName();
+        if (validString(simCarrierIdName)) {
+            name = simCarrierIdName.toString();
+        }
+        String simOperator = telephonyManager.getSimOperator();
+        if (validString(simOperator) && simOperator.length() >= 5) {
+            mobileCountryCode = simOperator.substring(0, 3);
+            mobileNetworkCode = simOperator.substring(3);
+        }
+        String providedIsoCountryCode = telephonyManager.getSimCountryIso();
+        if (validString(providedIsoCountryCode)) {
+            isoCountryCode = providedIsoCountryCode;
+        }
+        return new Carrier(id, name, mobileCountryCode, mobileNetworkCode, isoCountryCode);
+    }
+
+    private boolean validString(CharSequence str) {
+        return !(str == null || str.length() == 0);
+    }
+}