Merge pull request #217 from bryce-b/network-info

added NetworkStatus package & injected it into network instrumentation

Author: Ignacio Bonafonte

Package.resolved

@@ -38,6 +38,8 @@ let package = Package(
         .library(name: "libInMemoryExporter", type: .static, targets: ["InMemoryExporter"]),
         .library(name: "DatadogExporter", type: .dynamic, targets: ["DatadogExporter"]),
         .library(name: "libDatadogExporter", type: .static, targets: ["DatadogExporter"]),
+        .library(name: "NetworkStatus", type: .static, targets: ["NetworkStatus"]),
+        .library(name: "libNetworkStatus", type: .static, targets: ["NetworkStatus"]),
         .executable(name: "simpleExporter", targets: ["SimpleExporter"]),
         .executable(name: "loggingTracer", targets: ["LoggingTracer"]),
     ],
@@ -48,6 +50,8 @@ let package = Package(
         .package(name: "grpc-swift", url: "https://github.com/grpc/grpc-swift.git", from: "1.0.0"),
         .package(name: "swift-atomics", url: "https://github.com/apple/swift-atomics.git", from: "0.0.1"),
         .package(name: "swift-metrics", url: "https://github.com/apple/swift-metrics.git", from: "2.1.1"),
+        .package(name: "Reachability", url: "https://github.com/ashleymills/Reachability.swift", .branch("master")),
+
     ],
     targets: [
         .target(name: "OpenTelemetryApi",
@@ -60,9 +64,13 @@ let package = Package(
                 path: "Sources/Instrumentation/SDKResourceExtension",
                 exclude: ["README.md"]),
         .target(name: "URLSessionInstrumentation",
-                dependencies: ["OpenTelemetrySdk"],
+                dependencies: ["OpenTelemetrySdk", "NetworkStatus"],
                 path: "Sources/Instrumentation/URLSession",
                 exclude: ["README.md"]),
+        .target(name: "NetworkStatus",
+                dependencies: ["Reachability"],
+                path: "Sources/Instrumentation/NetworkStatus",
+                linkerSettings: [.linkedFramework("CoreTelephony")]),
         .target(name: "SignPostIntegration",
                 dependencies: ["OpenTelemetrySdk"],
                 path: "Sources/Instrumentation/SignPostIntegration",
@@ -104,6 +112,9 @@ let package = Package(
                 dependencies: ["OpenTelemetrySdk"],
                 path: "Sources/Exporters/DatadogExporter",
                 exclude: ["NOTICE", "README.md"]),
+        .testTarget(name: "NetworkStatusTests",
+                    dependencies: ["NetworkStatus"],
+                    path: "Tests/InstrumentationTests/NetworkStatusTests"),
         .testTarget(name: "OpenTelemetryApiTests",
                     dependencies: ["OpenTelemetryApi"],
                     path: "Tests/OpenTelemetryApiTests"),

Package.swift

@@ -0,0 +1,33 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import Foundation
+import Reachability
+
+public class NetworkMonitor : NetworkMonitorProtocol {
+    public private(set) var reachability :Reachability
+    
+    public init() throws {
+        reachability = try Reachability()
+        try reachability.startNotifier()
+    }
+
+    deinit {
+        reachability.stopNotifier()
+    }
+    
+    public func getConnection() -> Connection {
+        switch reachability.connection {
+        case .wifi:
+            return .wifi
+        case .cellular:
+            return .cellular
+        case .unavailable:
+            return .unavailable
+        }
+    }
+    
+    
+}

Sources/Instrumentation/NetworkStatus/NetworkMonitor.swift

@@ -0,0 +1,13 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import Foundation
+
+public enum Connection {
+    case unavailable, wifi, cellular
+}
+public protocol NetworkMonitorProtocol {
+    func getConnection() -> Connection;
+}

Sources/Instrumentation/NetworkStatus/NetworkMonitorProtocol.swift

@@ -0,0 +1,79 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#if os(iOS)
+
+    import CoreTelephony
+    import Foundation
+    import Network
+    import Reachability
+
+    public class NetworkStatus {
+        public private(set) var networkInfo: CTTelephonyNetworkInfo
+        public private(set) var networkMonitor: NetworkMonitorProtocol
+        public convenience init() throws {
+            self.init(with: try NetworkMonitor())
+        }
+
+        public init(with monitor: NetworkMonitorProtocol, info: CTTelephonyNetworkInfo = CTTelephonyNetworkInfo()) {
+            networkMonitor = monitor
+            networkInfo = info
+        }
+
+        public func status() -> (String, String?, CTCarrier?) {
+            switch networkMonitor.getConnection() {
+            case .wifi:
+                return ("wifi", nil, nil)
+            case .cellular:
+                if #available(iOS 13.0, *) {
+                    if let serviceId = networkInfo.dataServiceIdentifier, let value = networkInfo.serviceCurrentRadioAccessTechnology?[serviceId] {
+                        return ("cell", simpleConnectionName(connectionType: value), networkInfo.serviceSubscriberCellularProviders?[networkInfo.dataServiceIdentifier!])
+                    }
+                } else {
+                    if let radioType = networkInfo.currentRadioAccessTechnology {
+                        return ("cell", simpleConnectionName(connectionType: radioType), networkInfo.subscriberCellularProvider)
+                    }
+                }
+                return ("cell", "unknown", nil)
+            case .unavailable:
+                return ("unavailable", nil, nil)
+            }
+        }
+
+        func simpleConnectionName(connectionType: String) -> String {
+            switch connectionType {
+            case "CTRadioAccessTechnologyEdge":
+                return "EDGE"
+            case "CTRadioAccessTechnologyCDMA1x":
+                return "CDMA"
+            case "CTRadioAccessTechnologyGPRS":
+                return "GPRS"
+            case "CTRadioAccessTechnologyWCDMA":
+                return "WCDMA"
+            case "CTRadioAccessTechnologyHSDPA":
+                return "HSDPA"
+            case "CTRadioAccessTechnologyHSUPA":
+                return "HSUPA"
+            case "CTRadioAccessTechnologyCDMAEVDORev0":
+                return "EVDO_0"
+            case "CTRadioAccessTechnologyCDMAEVDORevA":
+                return "EVDO_A"
+            case "CTRadioAccessTechnologyCDMAEVDORevB":
+                return "EVDO_B"
+            case "CTRadioAccessTechnologyeHRPD":
+                return "HRPD"
+            case "CTRadioAccessTechnologyLTE":
+                return "LTE"
+            case "CTRadioAccessTechnologyNRNSA":
+                return "NRNSA"
+            case "CTRadioAccessTechnologyNR":
+                return "NR"
+            default:
+                return "unknown"
+            }
+        }
+    }
+
+#endif // os(iOS)

Sources/Instrumentation/NetworkStatus/NetworkStatus.swift

@@ -0,0 +1,45 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#if os(iOS)
+    import CoreTelephony
+    import Foundation
+    import Network
+    import OpenTelemetryApi
+    public class NetworkStatusInjector {
+        private var netstat: NetworkStatus
+
+        public init(netstat: NetworkStatus) {
+            self.netstat = netstat
+        }
+
+        public func inject(span: Span) {
+            let (type, subtype, carrier) = netstat.status()
+            span.setAttribute(key: "net.host.connection.type", value: AttributeValue.string(type))
+
+            if let subtype: String = subtype {
+                span.setAttribute(key: "net.host.connection.subtype", value: AttributeValue.string(subtype))
+            }
+
+            if let carrierInfo: CTCarrier = carrier {
+                if let carrierName = carrierInfo.carrierName {
+                    span.setAttribute(key: "net.host.carrier.name", value: AttributeValue.string(carrierName))
+                }
+
+                if let isoCountryCode = carrierInfo.isoCountryCode {
+                    span.setAttribute(key: "net.host.carrier.icc", value: AttributeValue.string(isoCountryCode))
+                }
+
+                if let mobileCountryCode = carrierInfo.mobileCountryCode {
+                    span.setAttribute(key: "net.host.carrier.mcc", value: AttributeValue.string(mobileCountryCode))
+                }
+
+                if let mobileNetworkCode = carrierInfo.mobileNetworkCode {
+                    span.setAttribute(key: "net.host.carrier.mnc", value: AttributeValue.string(mobileNetworkCode))
+                }
+            }
+        }
+    }
+#endif

Sources/Instrumentation/NetworkStatus/NetworkStatusInjector.swift

@@ -0,0 +1,14 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#if os(iOS)
+import Foundation
+import CoreTelephony
+
+public protocol NetworkStatusProtocol {
+    var networkMonitor : NetworkMonitorProtocol { get }
+    func getStatus() -> (String, CTCarrier?)
+}
+#endif

Sources/Instrumentation/NetworkStatus/NetworkStatusProtocol.swift

@@ -7,6 +7,10 @@ import Foundation
 import OpenTelemetryApi
 import OpenTelemetrySdk
 
+#if os(iOS)
+import NetworkStatus
+#endif //os(iOS)
+
 class URLSessionLogger {
     static var runningSpans = [String: Span]()
     static var runningSpansQueue = DispatchQueue(label: "io.opentelemetry.URLSessionLogger")
@@ -61,6 +65,13 @@ class URLSessionLogger {
             returnRequest = instrumentedRequest(for: request, span: span, instrumentation: instrumentation)
         }
 
+        #if os(iOS)
+        if let injector = self.netstatInjector {
+            injector.inject(span: span)
+        }
+        #endif
+
+
         instrumentation.configuration.createdRequest?(returnRequest ?? request, span)
 
         return returnRequest ?? request