Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add OTel-Swift supported Tracing #910

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ let libXML2TargetOrNil: Target? = nil
let package = Package(
name: "smithy-swift",
platforms: [
.macOS(.v10_15),
.macOS(.v12),
.iOS(.v13),
.tvOS(.v13),
.watchOS(.v6)
Expand Down Expand Up @@ -58,6 +58,7 @@ let package = Package(
var dependencies: [Package.Dependency] = [
.package(url: "https://github.com/awslabs/aws-crt-swift.git", exact: "0.45.0"),
.package(url: "https://github.com/apple/swift-log.git", from: "1.0.0"),
.package(url: "https://github.com/open-telemetry/opentelemetry-swift", from: "1.13.0"),
]
let isDocCEnabled = ProcessInfo.processInfo.environment["AWS_SWIFT_SDK_ENABLE_DOCC"] != nil
if isDocCEnabled {
Expand Down Expand Up @@ -95,6 +96,23 @@ let package = Package(
"SmithyChecksums",
"SmithyCBOR",
.product(name: "AwsCommonRuntimeKit", package: "aws-crt-swift"),
.product(name: "InMemoryExporter", package: "opentelemetry-swift"),
// Only include these on macOS, iOS, tvOS, and watchOS (visionOS and Linux are excluded)
.product(
name: "OpenTelemetryApi",
package: "opentelemetry-swift",
condition: .when(platforms: [.macOS, .iOS, .tvOS, .watchOS])
),
.product(
name: "OpenTelemetrySdk",
package: "opentelemetry-swift",
condition: .when(platforms: [.macOS, .iOS, .tvOS, .watchOS])
),
.product(
name: "OpenTelemetryProtocolExporterHTTP",
package: "opentelemetry-swift",
condition: .when(platforms: [.macOS, .iOS, .tvOS, .watchOS])
),
],
resources: [
.copy("PrivacyInfo.xcprivacy")
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

#if !(os(Linux) || os(visionOS))
import OpenTelemetryApi
import OpenTelemetrySdk
import Smithy
import OpenTelemetryProtocolExporterHttp

Check failure on line 12 in Sources/ClientRuntime/Telemetry/Providers/OpenTelemetry/OTelProvider.swift

View workflow job for this annotation

GitHub Actions / swiftlint

Imports should be sorted (sorted_imports)
import Foundation

Check failure on line 13 in Sources/ClientRuntime/Telemetry/Providers/OpenTelemetry/OTelProvider.swift

View workflow job for this annotation

GitHub Actions / swiftlint

Imports should be sorted (sorted_imports)

/// Namespace for the SDK Telemetry implementation.
public enum OpenTelemetrySwift {
/// The SDK TelemetryProviderOTel Implementation.
///
/// - contextManager: no-op
/// - loggerProvider: provides SwiftLoggers
/// - meterProvider: no-op
/// - tracerProvider: provides OTelTracerProvider with InMemoryExporter
public static func provider(spanExporter: any SpanExporter) -> TelemetryProvider {
return OpenTelemetrySwiftProvider(spanExporter: spanExporter)
}

public final class OpenTelemetrySwiftProvider: TelemetryProvider {
public let contextManager: TelemetryContextManager
public let loggerProvider: LoggerProvider
public let meterProvider: MeterProvider
public let tracerProvider: TracerProvider

public init(spanExporter: SpanExporter) {
self.contextManager = DefaultTelemetry.defaultContextManager
self.loggerProvider = DefaultTelemetry.defaultLoggerProvider
self.meterProvider = DefaultTelemetry.defaultMeterProvider
self.tracerProvider = OTelTracerProvider(spanExporter: spanExporter)
}
}
}
#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

#if !(os(Linux) || os(visionOS))
@preconcurrency import OpenTelemetryApi
@preconcurrency import OpenTelemetrySdk
import Smithy

public typealias OpenTelemetryTracer = OpenTelemetryApi.Tracer
public typealias OpenTelemetrySpanKind = OpenTelemetryApi.SpanKind
public typealias OpenTelemetrySpan = OpenTelemetryApi.Span
public typealias OpenTelemetryStatus = OpenTelemetryApi.Status

// Trace
public final class OTelTracerProvider: TracerProvider {
private let sdkTracerProvider: TracerProviderSdk

public init(spanExporter: SpanExporter) {
self.sdkTracerProvider = TracerProviderBuilder()
.add(spanProcessor: SimpleSpanProcessor(spanExporter: spanExporter))
.with(resource: Resource())
.build()
}

public func getTracer(scope: String, attributes: Attributes?) -> any Tracer {
let tracer = self.sdkTracerProvider.get(instrumentationName: scope)
return OTelTracerImpl(otelTracer: tracer)
}
}

public final class OTelTracerImpl: Tracer {
private let otelTracer: OpenTelemetryTracer

public init(otelTracer: OpenTelemetryTracer) {
self.otelTracer = otelTracer
}

public func createSpan(
name: String,
initialAttributes: Attributes?, spanKind: SpanKind, parentContext: (any TelemetryContext)?
) -> any TraceSpan {
let spanBuilder = self.otelTracer
.spanBuilder(spanName: name)
.setSpanKind(spanKind: spanKind.toOTelSpanKind())

initialAttributes?.getKeys().forEach { key in
spanBuilder.setAttribute(
key: key,
value: (initialAttributes?.get(key: AttributeKey<String>(name: key)))!
)
}

return OTelTraceSpanImpl(name: name, otelSpan: spanBuilder.startSpan())
}
}

private final class OTelTraceSpanImpl: TraceSpan {
let name: String
private let otelSpan: OpenTelemetrySpan

public init(name: String, otelSpan: OpenTelemetrySpan) {
self.name = name
self.otelSpan = otelSpan
}

func emitEvent(name: String, attributes: Attributes?) {
if let attributes = attributes, !(attributes.size == 0) {
self.otelSpan.addEvent(name: name, attributes: attributes.toOtelAttributes())
} else {
self.otelSpan.addEvent(name: name)
}
}

func setAttribute<T>(key: AttributeKey<T>, value: T) {
self.otelSpan.setAttribute(key: key.getName(), value: AttributeValue.init(value))
}

func setStatus(status: TraceSpanStatus) {
self.otelSpan.status = status.toOTelStatus()
}

func end() {
self.otelSpan.end()
}
}

extension SpanKind {
func toOTelSpanKind() -> OpenTelemetrySpanKind {
switch self {
case .client:
return .client
case .consumer:
return .consumer
case .internal:
return .internal
case .producer:
return .producer
case .server:
return .server
}
}
}

extension TraceSpanStatus {
func toOTelStatus() -> OpenTelemetryStatus {
switch self {
case .error:
return .error(description: "An error occured!") // status doesn't have error description
case .ok:
return .ok
case .unset:
return .unset
}
}
}
#endif
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
//
// Copyright Amazon.com Inc. or its affiliates.
// All Rights Reserved.
//
// SPDX-License-Identifier: Apache-2.0
//

#if !(os(Linux) || os(visionOS))
import OpenTelemetryApi

import Smithy

extension Attributes {
public func toOtelAttributes() -> [String: AttributeValue] {
let keys: [String] = self.getKeys()
var otelKeys: [String: AttributeValue] = [:]

guard !keys.isEmpty else {
return [:]
}

keys.forEach { key in
otelKeys[key] = AttributeValue(self.get(key: AttributeKey(name: key))!)
}

return otelKeys
}
}
#endif
8 changes: 8 additions & 0 deletions Sources/Smithy/Attribute.swift
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ public struct AttributeKey<ValueType>: Sendable {
self.name = name
}

public func getName() -> String {
return self.name
}

func toString() -> String {
return "AttributeKey: \(name)"
}
Expand All @@ -33,6 +37,10 @@ public struct Attributes {
get(key: key) != nil
}

public func getKeys() -> [String] {
return Array(self.attributes.keys)
}

public mutating func set<T>(key: AttributeKey<T>, value: T?) {
attributes[key.name] = value
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class PackageManifestGenerator(
writer.write("name: \$S,", ctx.settings.moduleName)

writer.openBlock("platforms: [", "],") {
writer.write(".macOS(.v10_15), .iOS(.v13)")
writer.write(".macOS(.v12), .iOS(.v13)")
}

writer.openBlock("products: [", "],") {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ class PackageManifestGeneratorTests {
assertNotNull(packageManifest)
val expected = """
platforms: [
.macOS(.v10_15), .iOS(.v13)
.macOS(.v12), .iOS(.v13)
],
"""
packageManifest.shouldContain(expected)
Expand Down
Loading