startSpan should take tracepoint location (#68)

ktoso · slashmo · web-flow · commit 8f5315e7c7b7 · 2022-11-07T19:35:13.000+09:00
Co-authored-by: Moritz Lang &lt;hi@slashmo.codes&gt;
diff --git a/Package.swift b/Package.swift
@@ -8,7 +8,7 @@ let package = Package(
         .library(name: "Tracing", targets: ["Tracing"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.4.1")),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.0.0"),
     ],
     targets: [
diff --git a/Package@swift-5.2.swift b/Package@swift-5.2.swift
@@ -8,7 +8,7 @@ let package = Package(
         .library(name: "Tracing", targets: ["Tracing"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.4.1")),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
diff --git a/Package@swift-5.3.swift b/Package@swift-5.3.swift
@@ -8,7 +8,7 @@ let package = Package(
         .library(name: "Tracing", targets: ["Tracing"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.4.1")),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
diff --git a/Package@swift-5.4.swift b/Package@swift-5.4.swift
@@ -8,7 +8,7 @@ let package = Package(
         .library(name: "Tracing", targets: ["Tracing"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.4.1")),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
diff --git a/Package@swift-5.5.swift b/Package@swift-5.5.swift
@@ -8,7 +8,7 @@ let package = Package(
         .library(name: "Tracing", targets: ["Tracing"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.3.0")),
+        .package(url: "https://github.com/apple/swift-distributed-tracing-baggage.git", .upToNextMinor(from: "0.4.1")),
     ],
     targets: [
         // ==== --------------------------------------------------------------------------------------------------------
diff --git a/Sources/Tracing/NoOpTracer.swift b/Sources/Tracing/NoOpTracer.swift
@@ -24,7 +24,10 @@ public struct NoOpTracer: Tracer {
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind,
-        at time: DispatchWallTime
+        at time: DispatchWallTime,
+        function: String,
+        file fileID: String,
+        line: UInt
     ) -> Span {
         NoOpSpan(baggage: baggage)
     }
diff --git a/Sources/Tracing/Tracer.swift b/Sources/Tracing/Tracer.swift
@@ -30,11 +30,17 @@ public protocol Tracer: Instrument {
     ///   - baggage: The `Baggage` providing information on where to start the new ``Span``.
     ///   - kind: The ``SpanKind`` of the new ``Span``.
     ///   - time: The `DispatchTime` at which to start the new ``Span``.
+    ///   - function: The function name in which the span was started
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
     func startSpan(
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind,
-        at time: DispatchWallTime
+        at time: DispatchWallTime,
+        function: String,
+        file fileID: String,
+        line: UInt
     ) -> Span
 
     /// Export all ended spans to the configured backend that have not yet been exported.
@@ -47,25 +53,111 @@ public protocol Tracer: Instrument {
 }
 
 extension Tracer {
-    /// Start a new ``Span`` with the given `Baggage` starting at `DispatchWallTime.now()`.
+    #if swift(>=5.3.0)
+    /// Start a new ``Span`` with the given `Baggage` starting "now".
     ///
     /// - Parameters:
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
     ///   - baggage: Baggage potentially containing trace identifiers of a parent ``Span``.
     ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
+    ///   - function: The function name in which the span was started.
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
     public func startSpan(
         _ operationName: String,
         baggage: Baggage,
-        ofKind kind: SpanKind = .internal
+        ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file fileID: String = #fileID,
+        line: UInt = #line
     ) -> Span {
-        self.startSpan(operationName, baggage: baggage, ofKind: kind, at: .now())
+        self.startSpan(
+            operationName,
+            baggage: baggage,
+            ofKind: kind,
+            at: .now(),
+            function: function,
+            file: fileID,
+            line: line
+        )
     }
+    #else
+    /// Start a new ``Span`` with the given `Baggage` starting "now".
+    ///
+    /// - Parameters:
+    ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
+    ///   - baggage: Baggage potentially containing trace identifiers of a parent ``Span``.
+    ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
+    ///   - function: The function name in which the span was started.
+    ///   - file: The `file` where the span was started.
+    ///   - line: The file line where the span was started.
+    public func startSpan(
+        _ operationName: String,
+        baggage: Baggage,
+        ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file: String = #file,
+        line: UInt = #line
+    ) -> Span {
+        self.startSpan(
+            operationName,
+            baggage: baggage,
+            ofKind: kind,
+            at: .now(),
+            function: function,
+            file: file,
+            line: line
+        )
+    }
+    #endif
 }
 
 // ==== ----------------------------------------------------------------------------------------------------------------
 // MARK: Starting spans: `withSpan`
 
 extension Tracer {
+    #if swift(>=5.3.0)
+    /// Execute a specific task within a newly created ``Span``.
+    ///
+    /// DO NOT `end()` the passed in span manually. It will be ended automatically when the `operation` returns.
+    ///
+    /// - Parameters:
+    ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
+    ///   - baggage: Baggage potentially containing trace identifiers of a parent ``Span``.
+    ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
+    ///   - operation: operation to wrap in a span start/end and execute immediately
+    ///   - function: The function name in which the span was started.
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
+    /// - Returns: the value returned by `operation`
+    /// - Throws: the error the `operation` has thrown (if any)
+    public func withSpan<T>(
+        _ operationName: String,
+        baggage: Baggage,
+        ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file fileID: String = #fileID,
+        line: UInt = #line,
+        _ operation: (Span) throws -> T
+    ) rethrows -> T {
+        let span = self.startSpan(
+            operationName,
+            baggage: baggage,
+            ofKind: kind,
+            at: .now(),
+            function: function,
+            file: fileID,
+            line: line
+        )
+        defer { span.end() }
+        do {
+            return try operation(span)
+        } catch {
+            span.recordError(error)
+            throw error // rethrow
+        }
+    }
+    #else
     /// Execute a specific task within a newly created ``Span``.
     ///
     /// DO NOT `end()` the passed in span manually. It will be ended automatically when the `operation` returns.
@@ -75,15 +167,29 @@ extension Tracer {
     ///   - baggage: Baggage potentially containing trace identifiers of a parent ``Span``.
     ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
     ///   - operation: operation to wrap in a span start/end and execute immediately
+    ///   - function: The function name in which the span was started.
+    ///   - file: The `#file` where the span was started.
+    ///   - line: The file line where the span was started.
     /// - Returns: the value returned by `operation`
     /// - Throws: the error the `operation` has thrown (if any)
     public func withSpan<T>(
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file: String = #file,
+        line: UInt = #line,
         _ operation: (Span) throws -> T
     ) rethrows -> T {
-        let span = self.startSpan(operationName, baggage: baggage, ofKind: kind)
+        let span = self.startSpan(
+            operationName,
+            baggage: baggage,
+            ofKind: kind,
+            at: .now(),
+            function: function,
+            file: file,
+            line: line
+        )
         defer { span.end() }
         do {
             return try operation(span)
@@ -92,6 +198,7 @@ extension Tracer {
             throw error // rethrow
         }
     }
+    #endif
 }
 
 // ==== ----------------------------------------------------------------------------------------------------------------
@@ -109,14 +216,27 @@ extension Tracer {
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
     ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
     ///   - operation: operation to wrap in a span start/end and execute immediately
+    ///   - function: The function name in which the span was started.
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
     /// - Returns: the value returned by `operation`
     /// - Throws: the error the `operation` has thrown (if any)
     public func withSpan<T>(
         _ operationName: String,
         ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file fileID: String = #fileID,
+        line: UInt = #line,
         _ operation: (Span) throws -> T
     ) rethrows -> T {
-        try self.withSpan(operationName, baggage: .current ?? .topLevel, ofKind: kind) { span in
+        try self.withSpan(
+            operationName,
+            baggage: .current ?? .topLevel,
+            ofKind: kind,
+            function: function,
+            file: fileID,
+            line: line
+        ) { span in
             try Baggage.$current.withValue(span.baggage) {
                 try operation(span)
             }
@@ -132,14 +252,27 @@ extension Tracer {
     ///   - operationName: The name of the operation being traced. This may be a handler function, database call, ...
     ///   - kind: The ``SpanKind`` of the ``Span`` to be created. Defaults to ``SpanKind/internal``.
     ///   - operation: operation to wrap in a span start/end and execute immediately
+    ///   - function: The function name in which the span was started.
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
     /// - Returns: the value returned by `operation`
     /// - Throws: the error the `operation` has thrown (if any)
     public func withSpan<T>(
         _ operationName: String,
         ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file fileID: String = #fileID,
+        line: UInt = #line,
         _ operation: (Span) async throws -> T
     ) async rethrows -> T {
-        let span = self.startSpan(operationName, baggage: .current ?? .topLevel, ofKind: kind)
+        let span = self.startSpan(
+            operationName,
+            baggage: .current ?? .topLevel,
+            ofKind: kind,
+            function: function,
+            file: fileID,
+            line: line
+        )
         defer { span.end() }
         do {
             return try await Baggage.$current.withValue(span.baggage) {
@@ -162,15 +295,21 @@ extension Tracer {
     //               task local and modified before passing into this function. The baggage will be made the current task-local baggage for the duration of the `operation`.
     ///   - kind: The `SpanKind` of the `Span` to be created. Defaults to `.internal`.
     ///   - operation: operation to wrap in a span start/end and execute immediately
+    ///   - function: The function name in which the span was started.
+    ///   - fileID: The `fileID` where the span was started.
+    ///   - line: The file line where the span was started.
     /// - Returns: the value returned by `operation`
     /// - Throws: the error the `operation` has thrown (if any)
     public func withSpan<T>(
         _ operationName: String,
         baggage: Baggage,
         ofKind kind: SpanKind = .internal,
+        function: String = #function,
+        file fileID: String = #fileID,
+        line: UInt = #line,
         _ operation: (Span) async throws -> T
     ) async rethrows -> T {
-        let span = self.startSpan(operationName, baggage: baggage, ofKind: kind)
+        let span = self.startSpan(operationName, baggage: baggage, ofKind: kind, function: function, file: fileID, line: line)
         defer { span.end() }
         do {
             return try await Baggage.$current.withValue(span.baggage) {
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
@@ -34,6 +34,7 @@ class LinuxMainRunnerImpl: LinuxMainRunner {
    @available(*, deprecated, message: "not actually deprecated. Just deprecated to allow deprecated tests (which test deprecated functionality) without warnings")
    func run() {
        XCTMain([
+             testCase(DynamicTracepointTracerTests.allTests),
              testCase(InstrumentTests.allTests),
              testCase(InstrumentationSystemTests.allTests),
              testCase(SpanTests.allTests),
diff --git a/Tests/TracingTests/DynamicTracepointTracerTests+XCTest.swift b/Tests/TracingTests/DynamicTracepointTracerTests+XCTest.swift
@@ -0,0 +1,34 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift Distributed Tracing open source project
+//
+// Copyright (c) 2020-2021 Apple Inc. and the Swift Distributed Tracing project
+// authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+//
+// DynamicTracepointTracerTests+XCTest.swift
+//
+import XCTest
+///
+/// NOTE: This file was generated by generate_linux_tests.rb
+///
+/// Do NOT edit this file directly as it will be regenerated automatically when needed.
+///
+
+extension DynamicTracepointTracerTests {
+
+   @available(*, deprecated, message: "not actually deprecated. Just deprecated to allow deprecated tests (which test deprecated functionality) without warnings")
+   static var allTests : [(String, (DynamicTracepointTracerTests) -> () throws -> Void)] {
+      return [
+                ("test_adhoc_enableBySourceLoc", test_adhoc_enableBySourceLoc),
+                ("test_adhoc_enableByFunction", test_adhoc_enableByFunction),
+           ]
+   }
+}
+
diff --git a/Tests/TracingTests/DynamicTracepointTracerTests.swift b/Tests/TracingTests/DynamicTracepointTracerTests.swift
diff --git a/Tests/TracingTests/TestTracer.swift b/Tests/TracingTests/TestTracer.swift
diff --git a/Tests/TracingTests/TracedLockTests.swift b/Tests/TracingTests/TracedLockTests.swift
