fix: set correct global attributes (signalfx#68)

Author: mhennoch

android/src/main/java/com/splunkotelreactnative/SplunkOtelReactNativeModule.java

@@ -95,7 +95,7 @@ public void initialize(ReadableMap configMap, Promise promise) {
     exporter = createExporter(endpointWithAuthentication, getReactApplicationContext(),
       mapReader.getEnableDiskBuffering(), mapReader.getMaxStorageUseMb());
 
-    crashReporter = new CrashReporter(exporter,
+    crashReporter = new CrashReporter(exporter, currentNetworkProvider,
       attributesFromMap(mapReader.getGlobalAttributes()), getReactApplicationContext());
 
     crashReporter.install();
@@ -134,7 +134,6 @@ public void export(ReadableArray spanMaps, Promise promise) {
     CurrentNetwork network = currentNetworkProvider.refreshNetworkStatus();
     CurrentNetworkAttributesExtractor networkAttributesExtractor = new CurrentNetworkAttributesExtractor();
     Attributes networkAttributes = networkAttributesExtractor.extract(network);
-    setGlobalAttributes(networkAttributes);
 
     for (int i = 0; i < spanMaps.size(); i++) {
       ReadableMap spanMap = spanMaps.getMap(i);

android/src/main/java/com/splunkotelreactnative/crash/CrashReporter.java

@@ -1,9 +1,13 @@
 package com.splunkotelreactnative.crash;
 
 import android.content.Context;
+import android.util.Log;
 
 import com.splunkotelreactnative.ReactSpanData;
 import com.splunkotelreactnative.ReactSpanProperties;
+import com.splunkotelreactnative.exporter.network.CurrentNetwork;
+import com.splunkotelreactnative.exporter.network.CurrentNetworkAttributesExtractor;
+import com.splunkotelreactnative.exporter.network.CurrentNetworkProvider;
 
 import java.util.Collections;
 import java.util.List;
@@ -27,16 +31,18 @@
 
 public class CrashReporter {
   private final SpanExporter exporter;
+  private final CurrentNetworkProvider currentNetworkProvider;
   private volatile Attributes globalAttributes;
   private volatile String sessionId;
   private final RuntimeDetailsExtractor runtimeDetailsExtractor;
   private final AtomicBoolean crashHappened = new AtomicBoolean(false);
   private final AnchoredClock clock;
   private final IdGenerator idGenerator;
 
-  public CrashReporter(SpanExporter exporter, Attributes globalAttributes, Context context) {
+  public CrashReporter(SpanExporter exporter, CurrentNetworkProvider currentNetworkProvider, Attributes globalAttributes, Context context) {
     this.exporter = exporter;
     this.globalAttributes = globalAttributes;
+    this.currentNetworkProvider = currentNetworkProvider;
     this.runtimeDetailsExtractor = RuntimeDetailsExtractor.create(context);
     this.clock = AnchoredClock.create(Clock.getDefault());
     this.idGenerator = IdGenerator.random();
@@ -113,6 +119,11 @@ private Attributes buildAttributes(ReactSpanProperties properties, Thread thread
       : CrashReporterAttributes.COMPONENT_ERROR;
     attributes.put(CrashReporterAttributes.COMPONENT_KEY, component);
 
+    CurrentNetwork network = currentNetworkProvider.refreshNetworkStatus();
+    CurrentNetworkAttributesExtractor networkAttributesExtractor = new CurrentNetworkAttributesExtractor();
+    Attributes networkAttributes = networkAttributesExtractor.extract(network);
+    attributes.putAll(networkAttributes);
+
     return attributes.build();
   }
 

example/__tests__/e2e/specs/navigation.e2e.ts

@@ -47,5 +47,7 @@ describe('Navigation', () => {
 
     expect(createSpan).toBeDefined();
     expect(createSpan.tags['screen.name']).toBe('Details');
+    expect(createSpan.tags['app']).toBe('RnExample');
+    expect(createSpan.tags['device.model.name']).toBeDefined();
   });
 });

example/ios/Podfile.lock

@@ -497,7 +497,7 @@ PODS:
     - RCT-Folly (= 2021.07.22.00)
     - React-Core
   - SocketRocket (0.6.1)
-  - splunk-otel-react-native (0.2.0):
+  - splunk-otel-react-native (0.3.0):
     - DeviceKit (~> 4.0)
     - PLCrashReporter (~> 1.11)
     - React-Core
@@ -739,10 +739,10 @@ SPEC CHECKSUMS:
   ReactCommon: 91ece8350ebb3dd2be9cef662abd78b6948233c0
   RNScreens: 3c2d122f5e08c192e254c510b212306da97d2581
   SocketRocket: f32cd54efbe0f095c4d7594881e52619cfe80b17
-  splunk-otel-react-native: b82a0b557bfd9518cd9d36b2e79b04227642bb02
+  splunk-otel-react-native: a9aa98bc64460b78fb470365cc465cdd7feba82b
   Yoga: 86fed2e4d425ee4c6eab3813ba1791101ee153c6
   YogaKit: f782866e155069a2cca2517aafea43200b01fd5a
 
-PODFILE CHECKSUM: 5009b8cc36e00dbdd65a448c2f8e5dfab9669070
+PODFILE CHECKSUM: 43525f2fc52f01068fed659b4b70dfe433901dd5
 
 COCOAPODS: 1.11.3

ios/SpanToDiskExporter.swift

@@ -16,6 +16,7 @@ limitations under the License.
 */
 
 import Foundation
+import DeviceKit
 
 /*
 Copyright 2022 Splunk Inc.
@@ -39,13 +40,15 @@ class SpanToDiskExporter : SpanExporter {
     let maxFileSizeBytes: Int64
     // Count of spans to insert before checking whether truncation is necessary
     let truncationCheckpoint: Int64
+    let deviceModel: String
     private var totalSpansInserted: Int64 = 0
     private var checkpointCounter: Int64 = 0
 
     init(spanDb: SpanDb, limitDiskUsageMegabytes: Int64, truncationCheckpoint: Int64) {
         self.db = spanDb
         self.maxFileSizeBytes = limitDiskUsageMegabytes * 1024 * 1024
         self.truncationCheckpoint = truncationCheckpoint
+        self.deviceModel = Device.current.description
     }
 
     public func shutdown() {}
@@ -71,6 +74,10 @@ class SpanToDiskExporter : SpanExporter {
                 span.tags["splunk.rumSessionId"] = sessionId
             }
 
+            if span.tags["device.model.name"] == nil {
+                span.tags["device.model.name"] = self.deviceModel
+            }            
+
             if networkInfo.hostConnectionType != nil {
                 span.tags["net.host.connection.type"] = networkInfo.hostConnectionType!
             }

ios/SplunkOtelReactNative.swift

@@ -24,7 +24,7 @@ class SplunkOtelReactNative: NSObject {
       let enableDiskBuffering = config["enableDiskBuffering"] as? Bool ?? true 
       let limitDiskUsageMegabytes = config["limitDiskUsageMegabytes"] as? Int64 ?? 25
       let truncationCheckpoint = config["truncationCheckpoint"] as? Int64 ?? 512
-        
+          
       let db = SpanDb(enableDiskBuffering: enableDiskBuffering)
       spanExporter = SpanToDiskExporter(spanDb: db, limitDiskUsageMegabytes: limitDiskUsageMegabytes, truncationCheckpoint: truncationCheckpoint)
       initializeCrashReporting(exporter: spanExporter)
@@ -76,10 +76,15 @@ class SplunkOtelReactNative: NSObject {
         updateCrashReportSessionId(id)
         resolve(true)
     }
-
+    
     @objc(setGlobalAttributes:withResolver:withRejecter:)
     func setGlobalAttributes(attributes: Dictionary<String, Any>, resolve: RCTPromiseResolveBlock, reject: RCTPromiseRejectBlock) {
-        let newAttribs: [String:String] = attributes.compactMapValues { v in
+        setGlobalAttributesInternally(attributes: attributes)
+        resolve(true)
+    }
+
+    private func setGlobalAttributesInternally(attributes: Dictionary<String, Any>) {
+        let newAttribs: [String: String] = attributes.compactMapValues { v in
             switch v {
             case is String:
                 return v as! String
@@ -95,7 +100,6 @@ class SplunkOtelReactNative: NSObject {
         }
 
         Globals.setGlobalAttributes(newAttribs)
-        resolve(true)
     }
 
     private func processStartTime() throws -> Date {

ios/ZipkinTransform.swift

@@ -15,7 +15,6 @@ limitations under the License.
 */
 
 import Foundation
-import DeviceKit
 
 // Zipkin conversion code modified from https://github.com/open-telemetry/opentelemetry-swift/blob/main/Sources/Exporters/Zipkin/Implementation/ZipkinConversionExtension.swift
 
@@ -130,8 +129,6 @@ struct ZipkinTransform {
             }
         }
 
-        tags["device.model.name"] = Device.current.description
-
         return ZipkinSpan(traceId: traceId,
                           parentId: parentId,
                           id: spanId,

src/native.ts

@@ -37,7 +37,7 @@ const SplunkOtelReactNative = NativeModules.SplunkOtelReactNative
 export interface NativeSdKConfiguration {
   beaconEndpoint?: string;
   rumAccessToken?: string;
-  globalAttributes?: object;
+  globalAttributes?: Attributes;
   enableDiskBuffering?: boolean;
   limitDiskUsageMegabytes?: number;
   truncationCheckpoint?: number;

src/splunkRum.ts

@@ -156,12 +156,23 @@ export const SplunkRum: SplunkRumType = {
       nativeSdkConf.beaconEndpoint = config.beaconEndpoint;
     }
 
+    const sessionId = getSessionId();
     nativeSdkConf.rumAccessToken = config.rumAccessToken;
     nativeSdkConf.enableDiskBuffering = config.enableDiskBuffering;
     nativeSdkConf.limitDiskUsageMegabytes = config.limitDiskUsageMegabytes;
-    nativeSdkConf.globalAttributes = { ...getResource() };
+    nativeSdkConf.globalAttributes = {
+      ...getResource(),
+      ...config.globalAttributes,
+      'splunk.rumSessionId': sessionId,
+      app: config.applicationName,
+    };
+
+    if (config.deploymentEnvironment) {
+      nativeSdkConf.globalAttributes['deployment.environment'] = config.deploymentEnvironment;
+    }
+    // make sure native crashreporter has correct attributes
+    setGlobalAttributes(nativeSdkConf.globalAttributes);
 
-    addGlobalAttributesFromConf(config);
     const provider = new WebTracerProvider({});
     provider.addSpanProcessor(new GlobalAttributeAppender());
     provider.addSpanProcessor(
@@ -196,8 +207,7 @@ export const SplunkRum: SplunkRumType = {
           appStartInfo.appStart || appStartInfo.moduleStart;
       }
       setNativeSessionId(getSessionId());
-      // make sure native crashreporter has correct attributes
-      setGlobalAttributes({});
+
       if (config.appStartEnabled) {
         const tracer = provider.getTracer('AppStart');
         const nativeInitEnd = Date.now();
@@ -238,19 +248,6 @@ export const SplunkRum: SplunkRumType = {
   updateLocation: updateLocation,
 };
 
-function addGlobalAttributesFromConf(config: ReactNativeConfiguration) {
-  const confAttributes: Attributes = {
-    ...config.globalAttributes,
-  };
-  confAttributes.app = config.applicationName;
-
-  if (config.deploymentEnvironment) {
-    confAttributes['deployment.environment'] = config.deploymentEnvironment;
-  }
-
-  setGlobalAttributes(confAttributes);
-}
-
 function updateLocation(latitude: number, longitude: number) {
   setGlobalAttributes({
     [LOCATION_LATITUDE]: latitude,