Add nil filtering & improve macOS support (#43)

* Nil filtering

* macOS support

Author: ladd

Sources/NautilusTelemetry/Exporters/Exporter.swift

@@ -7,6 +7,8 @@
 
 import Foundation
 
+// MARK: - Exporter
+
 /// Provides conversions to OTLP-JSON format
 public struct Exporter {
 
@@ -106,9 +108,10 @@ public struct Exporter {
 			return nil
 		}
 
+		let filteredAttributes = attributes.filteringNilValues()
 		var otlpAttributes = [OTLP.V1KeyValue]()
 
-		let keys = attributes.keys.sorted()
+		let keys = filteredAttributes.keys.sorted()
 		for key in keys {
 			if let value = attributes[key] {
 				if let v1AnyValue = convertToOTLP(value: value) {
@@ -124,3 +127,18 @@ public struct Exporter {
 	}
 
 }
+
+extension Dictionary where Value == AnyHashable {
+
+	/// Filters Optional values boxed as AnyHashable
+	/// - Returns: a filtered dictionary, with optional values removed
+	func filteringNilValues() -> [Key: Value] {
+		compactMapValues { value -> AnyHashable? in
+			// Check if the AnyHashable wraps an Optional that is nil
+			if case Optional<Any>.none = value.base {
+				return nil
+			}
+			return value
+		}
+	}
+}

Sources/NautilusTelemetry/Instrumentation/HardwareDetails.swift

@@ -25,7 +25,10 @@ public enum HardwareDetails {
 	// MARK: Private
 
 	private static var isOnMac: Bool = {
-		// This doesn't change after launch, so evaluate once.
+		#if os(macOS)
+		true
+		#else
+		/// This doesn't change after launch, so evaluate once.
 		var isOnMac = false
 
 		#if targetEnvironment(simulator)
@@ -43,8 +46,8 @@ public enum HardwareDetails {
 			}
 		}
 		#endif
-
 		return isOnMac
+		#endif
 	}()
 
 	private static func sysctlbyname(_ name: String) -> String {

Sources/NautilusTelemetry/Instrumentation/ResourceAttributes.swift

@@ -24,7 +24,7 @@ public struct ResourceAttributes {
 		vendorIdentifier: String,
 		deviceModelIdentifier: String,
 		osType: String = "darwin",
-		osName: String = "iOS",
+		osName: String = defaultOSName,
 		osVersion: String,
 		additionalAttributes: TelemetryAttributes?
 	) {
@@ -40,6 +40,14 @@ public struct ResourceAttributes {
 
 	// MARK: Public
 
+	#if os(macOS)
+	public static let defaultOSName = "macOS"
+	#elseif os(iOS)
+	public static let defaultOSName = "iOS"
+	#else
+	public static let defaultOSName = "unknown"
+	#endif
+
 	/// Create a default set of resource attributes.
 	/// - Parameter additionalAttributes: Additional attributes, that may override existing attributes. Must conform to https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/attribute-naming.md
 	/// - Returns: Built attributes.
@@ -96,7 +104,7 @@ public struct ResourceAttributes {
 		var attributes = TelemetryAttributes()
 
 		// https://opentelemetry.io/docs/specs/semconv/registry/attributes/service/
-		attributes["service.name"] = "ios.app"
+		attributes["service.name"] = "\(osName.lowercased()).app"
 		attributes["service.namespace"] = bundleIdentifier
 		attributes["service.version"] = applicationVersion
 		attributes["telemetry.sdk.name"] = "NautilusTelemetry"
@@ -108,7 +116,7 @@ public struct ResourceAttributes {
 		attributes["device.manufacturer"] = "Apple"
 		attributes["device.model"] = deviceModelIdentifier
 
-		// https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/os.md
+		// https://opentelemetry.io/docs/specs/semconv/resource/os/
 		attributes["os.type"] = osType
 		attributes["os.name"] = osName
 		attributes["os.version"] = osVersion

Sources/NautilusTelemetry/Tracing/Span.swift

@@ -117,6 +117,8 @@ public final class Span: Identifiable {
 	///   - name: a name, conforming to https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions
 	///   - value: a value.
 	public func addAttribute(_ name: String, _ value: AnyHashable?) {
+		guard let value else { return }
+
 		// AnyHashable is not Sendable. For now, make this unchecked, but could consider wrapping ala:
 		// https://github.com/pointfreeco/swift-concurrency-extras/blob/main/Sources/ConcurrencyExtras/AnyHashableSendable.swift
 		lock.withLockUnchecked {

Tests/NautilusTelemetryTests/Exporters/ExporterTests.swift

@@ -202,4 +202,32 @@ final class ExporterTests: XCTestCase {
 		let convertedEmptyBounds = exporter.convertToOTLP(explicitBounds: emptyBounds)
 		XCTAssertEqual(convertedEmptyBounds, [])
 	}
+
+	func testFilteringNilValues() throws {
+		// Test that nil values wrapped in AnyHashable are properly filtered out
+		let nilValue: String? = nil
+		let validString = "hello"
+		let validInt = 42
+		let validBool = true
+
+		let dictionary: [String: AnyHashable] = [
+			"nilKey": AnyHashable(nilValue),
+			"stringKey": AnyHashable(validString),
+			"intKey": AnyHashable(validInt),
+			"boolKey": AnyHashable(validBool),
+		]
+
+		let filtered = dictionary.filteringNilValues()
+
+		// Verify that the nil value was removed
+		XCTAssertNil(filtered["nilKey"])
+
+		// Verify that valid values remain
+		XCTAssertEqual(filtered["stringKey"] as? String, validString)
+		XCTAssertEqual(filtered["intKey"] as? Int, validInt)
+		XCTAssertEqual(filtered["boolKey"] as? Bool, validBool)
+
+		// Verify the count
+		XCTAssertEqual(filtered.count, 3)
+	}
 }

Tests/NautilusTelemetryTests/Utilities/ResourceAttributesTests.swift

@@ -19,16 +19,25 @@ final class ResourceAttributesTests: XCTestCase {
 
 		_ = try XCTUnwrap(exporter.convertToOTLP(attributes: attributes)) // make sure it converts
 
-		_ = try XCTUnwrap(attributes["service.name"])
+		let serviceName = try XCTUnwrap(attributes["service.name"] as? String)
 		_ = try XCTUnwrap(attributes["service.version"])
 		_ = try XCTUnwrap(attributes["telemetry.sdk.name"])
 		_ = try XCTUnwrap(attributes["telemetry.sdk.language"])
 		_ = try XCTUnwrap(attributes["device.id"])
 		_ = try XCTUnwrap(attributes["foo"])
 		_ = try XCTUnwrap(attributes["os.type"])
-		_ = try XCTUnwrap(attributes["os.name"])
+		let osName = try XCTUnwrap(attributes["os.name"] as? String)
 		let osVersion = try XCTUnwrap(attributes["os.version"] as? String)
 
+		// Verify platform-specific OS name
+		#if os(macOS)
+		XCTAssertEqual(osName, "macOS")
+		XCTAssertEqual(serviceName, "macos.app")
+		#elseif os(iOS)
+		XCTAssertEqual(osName, "iOS")
+		XCTAssertEqual(serviceName, "ios.app")
+		#endif
+
 		let components = osVersion.split(separator: ".")
 		XCTAssert(components.count >= 2)