@@ -17,14 +17,14 @@ import Tracing
1717
1818/// An in-memory implementation of the ``Tracer`` protocol which can be used either in testing,
1919/// or in manual collecting and interrogating traces within a process, and acting on them programatically.
20- ///
20+ ///
2121/// ### Span lifecycle
2222/// This tracer does _not_ automatically remove spans once they end.
2323/// Finished spans are retained and available for inspection using the `finishedSpans` property.
24- /// Spans which have been started but have not yet been called `Span/end()` on are also available
24+ /// Spans which have been started but have not yet been called `Span/end()` on are also available
2525/// for inspection using the ``activeSpans`` property.
26- ///
27- /// Spans are retained by the `InMemoryTracer` until they are explicitly removed, e.g. by using
26+ ///
27+ /// Spans are retained by the `InMemoryTracer` until they are explicitly removed, e.g. by using
2828/// ``popFinishedSpans()`` or any of the `clear...` methods (e.g. ``clearFinishedSpans()``)
2929public struct InMemoryTracer : Tracer {
3030
@@ -41,15 +41,15 @@ public struct InMemoryTracer: Tracer {
4141 private let _extractions = LockedValueBox < [ Extraction ] > ( [ ] )
4242
4343 /// Create a new ``InMemoryTracer``.
44- ///
45- /// - Parameters:
44+ ///
45+ /// - Parameters:
4646 /// - Parameter idGenerator: strategy for generating trace and span identifiers
4747 /// - Parameter idGenerator: strategy for generating trace and span identifiers
4848 public init (
4949 idGenerator: IDGenerator = . incrementing,
5050 recordInjections: Bool = true ,
5151 recordExtractions: Bool = true
52- ) {
52+ ) {
5353 self . idGenerator = idGenerator
5454 self . recordInjections = recordInjections
5555 self . recordExtractions = recordExtractions
@@ -114,7 +114,7 @@ extension InMemoryTracer {
114114
115115extension InMemoryTracer {
116116
117- /// Array of active spans, i.e. spans which have been started by have not yet finished (by calling `Span/end()`).
117+ /// Array of active spans, i.e. spans which have been started but have not yet finished (by calling `Span/end()`).
118118 public var activeSpans : [ InMemorySpan ] {
119119 _activeSpans. withValue { active in Array ( active. values) }
120120 }
@@ -132,15 +132,15 @@ extension InMemoryTracer {
132132 }
133133
134134 /// Gets, without removing, all the finished spans recorded by this tracer.
135- ///
135+ ///
136136 /// - SeeAlso: `popFinishedSpans()`
137137 public var finishedSpans : [ FinishedInMemorySpan ] {
138138 _finishedSpans. withValue { $0 }
139139 }
140-
140+
141141 /// Returns, and removes, all finished spans recorded by this tracer.
142142 public func popFinishedSpans( ) -> [ FinishedInMemorySpan ] {
143- _finishedSpans. withValue { spans in
143+ _finishedSpans. withValue { spans in
144144 defer { spans = [ ] }
145145 return spans
146146 }
@@ -152,10 +152,13 @@ extension InMemoryTracer {
152152 }
153153
154154 /// Clears all registered finished spans, as well as injections/extractions performed by this tracer.
155- public func clearAll( ) {
155+ public func clearAll( includingActive : Bool = false ) {
156156 _finishedSpans. withValue { $0 = [ ] }
157157 _injections. withValue { $0 = [ ] }
158158 _extractions. withValue { $0 = [ ] }
159+ if includingActive {
160+ _activeSpans. withValue { $0 = [ : ] }
161+ }
159162 }
160163}
161164
@@ -235,13 +238,12 @@ extension InMemoryTracer {
235238 _extractions. withValue { $0 }
236239 }
237240
238-
239241 /// Represents a recorded call to the InMemoryTracer's ``Instrument/extract(_:into:using:)`` method.
240242 public struct Extraction : Sendable {
241243 /// The carrier object from which the context values were extracted from,
242244 /// e.g. this frequently is an HTTP request or similar.
243245 public let carrier : any Sendable
244- /// The constructed service context, containing the extracted ``ServiceContext/inMemoryTraceContext ``.
246+ /// The constructed service context, containing the extracted ``ServiceContext/inMemorySpanContext ``.
245247 public let context : ServiceContext
246248 }
247249}
@@ -251,7 +253,7 @@ extension InMemoryTracer {
251253extension InMemoryTracer {
252254
253255 /// Can be used to customize how trace and span IDs are generated by the ``InMemoryTracer``.
254- ///
256+ ///
255257 /// Defaults to a simple sequential numeric scheme (`span-1`, `span-2`, `trace-1`, `trace-2` etc).
256258 public struct IDGenerator : Sendable {
257259 public let nextTraceID : @Sendable ( ) -> String
0 commit comments