This repository was archived by the owner on Apr 23, 2021. It is now read-only.
+poc,instruments PoC of an Instruments.app instrument "tracing" (naive) #97
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,267 @@ | ||
| //===----------------------------------------------------------------------===// | ||
| // | ||
| // This source file is part of the Swift Tracing open source project | ||
| // | ||
| // Copyright (c) 2020 Moritz Lang and the Swift Tracing project authors | ||
| // Licensed under Apache License v2.0 | ||
| // | ||
| // See LICENSE.txt for license information | ||
| // | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // | ||
| //===----------------------------------------------------------------------===// | ||
|
|
||
| import Baggage | ||
| import Instrumentation | ||
| import Foundation // string conversion for os_log seems to live here | ||
|
|
||
| #if os(macOS) || os(tvOS) || os(iOS) || os(watchOS) | ||
| import os.log | ||
| import os.signpost | ||
|
|
||
| // ==== ---------------------------------------------------------------------------------------------------------------- | ||
| // MARK: OSSignpost Tracing | ||
|
|
||
| @available(OSX 10.14, *) | ||
|
There was a problem hiding this comment. since signposts are only available since then. |
||
| @available(iOS 10.0, *) | ||
| @available(tvOS 10.0, *) | ||
| @available(watchOS 3.0, *) | ||
| public struct OSSignpostTracingInstrument: TracingInstrument { | ||
| let log: OSLog | ||
| let signpostName: StaticString | ||
|
|
||
| public init(subsystem: String, category: String, signpostName: StaticString) { | ||
| self.log = OSLog(subsystem: subsystem, category: category) | ||
| self.signpostName = signpostName | ||
| } | ||
|
|
||
| // ==== ------------------------------------------------------------------------------------------------------------ | ||
| // MARK: Instrument API | ||
|
|
||
| public func extract<Carrier, Extractor>(_ carrier: Carrier, into baggage: inout BaggageContext, using extractor: Extractor) { | ||
| // noop; we could handle extracting our keys here | ||
| } | ||
|
|
||
| public func inject<Carrier, Injector>(_ baggage: BaggageContext, into carrier: inout Carrier, using injector: Injector) { | ||
| // noop; we could handle injecting our keys here | ||
| } | ||
|
|
||
| // ==== ------------------------------------------------------------------------------------------------------------ | ||
| // MARK: Tracing Instrument API | ||
|
|
||
| public func startSpan( | ||
| named operationName: String, | ||
| context: BaggageContext, | ||
| ofKind kind: SpanKind, | ||
| at timestamp: Timestamp? | ||
| ) -> Span { | ||
| OSSignpostSpan( | ||
| log: self.log, | ||
| named: operationName, | ||
| signpostName: self.signpostName, | ||
| context: context | ||
| // , kind ignored | ||
| // , timestamp ignored, we capture it automatically | ||
| ) | ||
| } | ||
| } | ||
|
Comment on lines
+52
to
+67
There was a problem hiding this comment. note that some tracer may choose not to expose setting the timestamp explicitly by user. this is the case with XRay tracer as well, at the moment (I dont really see a use case for that); BTW this is not required by OT |
||
|
|
||
| // ==== ---------------------------------------------------------------------------------------------------------------- | ||
| // MARK: OSSignpost Span | ||
|
|
||
| @available(OSX 10.14, *) | ||
| @available(iOS 10.0, *) | ||
| @available(tvOS 10.0, *) | ||
| @available(watchOS 3.0, *) | ||
| final class OSSignpostSpan: Span { | ||
| let operationName: String | ||
| var context: BaggageContext | ||
|
|
||
| private let log: OSLog | ||
| private let signpostName: StaticString | ||
| private var signpostID: OSSignpostID { | ||
| self.context.signpostID! // guaranteed that we have "our" ID | ||
| } | ||
|
|
||
| // TODO: use os_unfair_lock | ||
| let lock: NSLock | ||
|
|
||
| public let isRecording: Bool | ||
|
|
||
| public let startTimestamp: Timestamp | ||
| public var endTimestamp: Timestamp? | ||
|
|
||
| public var status: SpanStatus? = nil | ||
| public let kind: SpanKind = .internal | ||
|
|
||
| public var baggage: BaggageContext { | ||
| self.context | ||
| } | ||
|
|
||
| static let beginFormat: StaticString = | ||
| """ | ||
| b;\ | ||
| id:%{public}ld;\ | ||
| parent-ids:%{public}s;\ | ||
| op-name:%{public}s | ||
| """ | ||
| static let endFormat: StaticString = | ||
| """ | ||
| e; | ||
| """ | ||
|
|
||
| init( | ||
| log: OSLog, | ||
| named operationName: String, | ||
| signpostName: StaticString, | ||
| context: BaggageContext | ||
| ) { | ||
| self.log = log | ||
| self.operationName = operationName | ||
| self.signpostName = signpostName | ||
| self.context = context | ||
|
|
||
| self.startTimestamp = .now() // meh | ||
| self.isRecording = log.signpostsEnabled | ||
|
|
||
| self.lock = NSLock() | ||
|
|
||
| // // if the context we were started with already had a signpostID, it means we're should link with it | ||
| // // TODO: is this right or we should rely on explicit link calls? | ||
| // if context.signpostID != nil { | ||
| // self.addLink(SpanLink(context: context)) | ||
| // } | ||
|
|
||
| // replace signpostID with "us" i.e. this span | ||
| let signpostID = OSSignpostID( | ||
| log: log, | ||
| object: self | ||
| ) | ||
| self.context.signpostID = signpostID | ||
|
|
||
| if self.isRecording { | ||
| os_signpost( | ||
| .begin, | ||
| log: self.log, | ||
| name: self.signpostName, | ||
| signpostID: self.signpostID, | ||
| Self.beginFormat, | ||
| self.signpostID.rawValue, | ||
| "\(context.signpostTraceParentIDs.map({ "\($0.rawValue)" }).joined(separator: ","))", | ||
| operationName | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| #if DEBUG | ||
| deinit { | ||
| // sanity checking if we don't accidentally drop spans on the floor without ending them | ||
| self.lock.lock() // TODO: somewhat bad idea, we should rather implement endTimestamp as an atomic that's lockless to read (!) | ||
| defer { self.lock.lock() } | ||
| if self.endTimestamp == nil { | ||
| print(""" | ||
| warning: | ||
| Span \(self.signpostID) (\(self.operationName)) \ | ||
| [todo:source location] \ | ||
| was dropped without end() being called! | ||
| """) | ||
| } | ||
| } | ||
| #endif | ||
ktoso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| public func addLink(_ link: SpanLink) { | ||
| guard self.isRecording else { return } | ||
| self.lock.lock() | ||
| defer { self.lock.unlock() } | ||
|
|
||
| guard let id = link.context.signpostID else { | ||
| print( | ||
| """ | ||
| Attempted to addLink(\(link)) to \(self.signpostID) (\(self.operationName))\ | ||
| but no `signpostID` present in passed in baggage context! | ||
| """ | ||
| ) | ||
| return | ||
| } | ||
|
|
||
| self.context.signpostTraceParentIDs += [id] | ||
| } | ||
|
|
||
| public func addEvent(_ event: SpanEvent) { | ||
| guard self.isRecording else { return } | ||
|
|
||
| // perhaps emit it as os_signpost(.event, ...) | ||
| } | ||
|
|
||
| public var attributes: SpanAttributes { | ||
| get { | ||
| [:] // ignore | ||
| } | ||
| set { | ||
| // ignore | ||
| } | ||
| } | ||
|
|
||
|
|
||
| public func end(at timestamp: Timestamp) { | ||
| guard self.isRecording else { return } | ||
| self.lock.lock() | ||
| defer { self.lock.unlock() } | ||
|
|
||
| guard self.endTimestamp == nil else { | ||
| print("warning: attempted to end() more-than-once the span: \(self.signpostID) (\(self.operationName))!") | ||
| return | ||
| } | ||
| self.endTimestamp = timestamp | ||
|
|
||
| os_signpost( | ||
| .end, | ||
| log: self.log, | ||
| name: self.signpostName, | ||
| signpostID: self.signpostID, | ||
| Self.endFormat | ||
| ) | ||
ktoso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } | ||
|
|
||
| // ==== ---------------------------------------------------------------------------------------------------------------- | ||
| // MARK: Baggage Keys | ||
|
|
||
| @available(OSX 10.14, *) | ||
| @available(iOS 10.0, *) | ||
| @available(tvOS 10.0, *) | ||
| @available(watchOS 3.0, *) | ||
| enum OSSignpostTracingKeys { | ||
| enum TraceParentIDs: BaggageContextKey { | ||
| typealias Value = [OSSignpostID] | ||
|
There was a problem hiding this comment. not "really" used and I don't think there's a good way to make use of this info in instruments... though I may have to learn more about it. Not a huge goal of this PoC anyway. |
||
| } | ||
| enum SignpostID: BaggageContextKey { | ||
| typealias Value = OSSignpostID | ||
| } | ||
| } | ||
|
|
||
| @available(OSX 10.14, *) | ||
| @available(iOS 10.0, *) | ||
| @available(tvOS 10.0, *) | ||
| @available(watchOS 3.0, *) | ||
| extension BaggageContext { | ||
| var signpostTraceParentIDs: OSSignpostTracingKeys.TraceParentIDs.Value { | ||
| get { | ||
| self[OSSignpostTracingKeys.TraceParentIDs.self] ?? [] | ||
| } | ||
| set { | ||
| self[OSSignpostTracingKeys.TraceParentIDs.self] = newValue | ||
| } | ||
| } | ||
| var signpostID: OSSignpostTracingKeys.SignpostID.Value? { | ||
| get { | ||
| self[OSSignpostTracingKeys.SignpostID.self] | ||
| } | ||
| set { | ||
| self[OSSignpostTracingKeys.SignpostID.self] = newValue | ||
| } | ||
| } | ||
| } | ||
|
|
||
| #endif | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is an apple platforms only thing