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

Add baggage span processor #673

Open
wants to merge 1 commit 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
7 changes: 7 additions & 0 deletions Package.swift
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ let package = Package(
.library(name: "NetworkStatus", type: .static, targets: ["NetworkStatus"]),
.library(name: "OTelSwiftLog", type: .static, targets: ["OTelSwiftLog"]),
.library(name: "DataCompression", type: .static, targets: ["DataCompression"]),
.library(name: "Contrib", targets: ["Contrib"]),
.executable(name: "simpleExporter", targets: ["SimpleExporter"]),
.executable(name: "OTLPExporter", targets: ["OTLPExporter"]),
.executable(name: "OTLPHTTPExporter", targets: ["OTLPHTTPExporter"]),
Expand Down Expand Up @@ -129,6 +130,9 @@ let package = Package(
.target(name: "PersistenceExporter",
dependencies: ["OpenTelemetrySdk"],
path: "Sources/Exporters/Persistence"),
.target(name: "Contrib",
dependencies: ["OpenTelemetryApi",
"OpenTelemetrySdk"]),
.testTarget(name: "OTelSwiftLogTests",
dependencies: ["OTelSwiftLog"],
path: "Tests/BridgesTests/OTelSwiftLog"),
Expand Down Expand Up @@ -185,6 +189,9 @@ let package = Package(
.testTarget(name: "PersistenceExporterTests",
dependencies: ["PersistenceExporter"],
path: "Tests/ExportersTests/PersistenceExporter"),
.testTarget(name: "ContribTests",
dependencies: ["Contrib",
"InMemoryExporter"]),
.target(name: "LoggingTracer",
dependencies: ["OpenTelemetryApi"],
path: "Examples/Logging Tracer"),
Expand Down
7 changes: 7 additions & 0 deletions [email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ let package = Package(
.library(name: "NetworkStatus", type: .static, targets: ["NetworkStatus"]),
.library(name: "OTelSwiftLog", type: .static, targets: ["OTelSwiftLog"]),
.library(name: "DataCompression", type: .static, targets: ["DataCompression"]),
.library(name: "Contrib", targets: ["Contrib"]),
.executable(name: "simpleExporter", targets: ["SimpleExporter"]),
.executable(name: "OTLPExporter", targets: ["OTLPExporter"]),
.executable(name: "OTLPHTTPExporter", targets: ["OTLPHTTPExporter"]),
Expand Down Expand Up @@ -134,6 +135,9 @@ let package = Package(
.target(name: "PersistenceExporter",
dependencies: ["OpenTelemetrySdk"],
path: "Sources/Exporters/Persistence"),
.target(name: "Contrib",
dependencies: ["OpenTelemetryApi",
"OpenTelemetrySdk"]),
.testTarget(name: "OTelSwiftLogTests",
dependencies: ["OTelSwiftLog"],
path: "Tests/BridgesTests/OTelSwiftLog"),
Expand Down Expand Up @@ -195,6 +199,9 @@ let package = Package(
.testTarget(name: "PersistenceExporterTests",
dependencies: ["PersistenceExporter"],
path: "Tests/ExportersTests/PersistenceExporter"),
.testTarget(name: "ContribTests",
dependencies: ["Contrib",
"InMemoryExporter"]),
.executableTarget(
name: "LoggingTracer",
dependencies: ["OpenTelemetryApi"],
Expand Down
9 changes: 8 additions & 1 deletion [email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ let package = Package(
.library(name: "InMemoryExporter", targets: ["InMemoryExporter"]),
.library(name: "OTelSwiftLog", targets: ["OTelSwiftLog"]),
.library(name: "DataCompression", type: .static, targets: ["DataCompression"]),
.library(name: "Contrib", targets: ["Contrib"]),
.executable(name: "ConcurrencyContext", targets: ["ConcurrencyContext"]),
.executable(name: "loggingTracer", targets: ["LoggingTracer"]),
],
Expand Down Expand Up @@ -85,6 +86,9 @@ let package = Package(
.target(name: "PersistenceExporter",
dependencies: ["OpenTelemetrySdk"],
path: "Sources/Exporters/Persistence"),
.target(name: "Contrib",
dependencies: ["OpenTelemetryApi",
"OpenTelemetrySdk"]),
.testTarget(name: "OTelSwiftLogTests",
dependencies: ["OTelSwiftLog"],
path: "Tests/BridgesTests/OTelSwiftLog"),
Expand Down Expand Up @@ -117,6 +121,9 @@ let package = Package(
.testTarget(name: "PersistenceExporterTests",
dependencies: ["PersistenceExporter"],
path: "Tests/ExportersTests/PersistenceExporter"),
.testTarget(name: "ContribTests",
dependencies: ["Contrib",
"InMemoryExporter"]),
.executableTarget(
name: "LoggingTracer",
dependencies: ["OpenTelemetryApi"],
Expand Down Expand Up @@ -295,7 +302,7 @@ if ProcessInfo.processInfo.environment["OTEL_ENABLE_SWIFTLINT"] != nil {
package.dependencies.append(contentsOf: [
.package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", from: "0.57.1")
])

for target in package.targets {
target.plugins = [
.plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLintPlugins"),
Expand Down
39 changes: 39 additions & 0 deletions Sources/Contrib/Processors/BaggageSpanProcessor.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

import Foundation
import OpenTelemetryApi
import OpenTelemetrySdk

public struct BaggageSpanProcessor: SpanProcessor {
public let isStartRequired = true
public let isEndRequired = false
public let filter: (Entry) -> Bool
public var activeBaggage: () -> Baggage? = {
return OpenTelemetry.instance.contextProvider.activeBaggage
}

public init(filter: @escaping (Entry) -> Bool) {
self.filter = filter
}

public func onStart(
parentContext: SpanContext?,
span: any ReadableSpan
) {
if let baggage = activeBaggage() {
let filteredEntries = baggage.getEntries().filter(self.filter)
for entry in filteredEntries {
span.setAttribute(key: entry.key.name, value: entry.value.string)
}
}
}

public func onEnd(span: any ReadableSpan) {}

public func shutdown(explicitTimeout: TimeInterval? = nil) {}

public func forceFlush(timeout: TimeInterval? = nil) {}
}
78 changes: 78 additions & 0 deletions Tests/ContribTests/Processors/BaggageSpanProcessorTests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/

import InMemoryExporter
import OpenTelemetryApi
import OpenTelemetrySdk
import Contrib
import XCTest

class BaggageSpanProcessorTests: XCTestCase {
func testProcessor() {
let processor = BaggageSpanProcessor(filter: { $0.key.name == "keepme" })
let exporter = InMemoryExporter()
let simple = SimpleSpanProcessor(spanExporter: exporter)
OpenTelemetry.registerTracerProvider(
tracerProvider: TracerProviderBuilder().add(spanProcessor: processor)
.add(spanProcessor: simple).build()
)
let tracer = OpenTelemetry.instance.tracerProvider.get(
instrumentationName: "test",
instrumentationVersion: "1.0.0"
)

guard let key = EntryKey(name: "test-key") else {
XCTFail()
return
}

guard let keep = EntryKey(name: "keepme") else {
XCTFail("cannot create entry key")
return
}

guard let value = EntryValue(string: "test-value") else {
XCTFail()
return
}

let parent = tracer.spanBuilder(spanName: "parent").startSpan()

// create two baggage items, one we will keep and one will
// be filtered out by the processor
let b = OpenTelemetry.instance.baggageManager.baggageBuilder()
.put(key: key, value: value, metadata: nil)
.put(key: keep, value: value, metadata: nil)
.build()
OpenTelemetry.instance.contextProvider.setActiveBaggage(b)

let child = tracer.spanBuilder(spanName: "child").startSpan()

child.end()
parent.end()

simple.forceFlush()

let spans = exporter.getFinishedSpanItems()
XCTAssertEqual(spans.count, 2)

guard let pChild = spans.first(where: { $0.name == "child" }) else {
XCTFail("failed to find child span")
return
}

XCTAssertTrue(spans.contains(where: { $0.name == "parent" }))

XCTAssertEqual(pChild.attributes.count, 1)

guard let attr = pChild.attributes.first else {
XCTFail("failed to get span attributes")
return
}

XCTAssertEqual(attr.key, "keepme")
XCTAssertEqual(attr.value.description, "test-value")
}
}
Loading