apple / swift-distributed-tracing

Instrumentation library for Swift server applications
https://swiftpackageindex.com/apple/swift-distributed-tracing/main/documentation/tracing
Apache License 2.0
224 stars 34 forks source link

Adds documentation on manual span propogation #153

Open NeedleInAJayStack opened 3 weeks ago

NeedleInAJayStack commented 3 weeks ago

Motivation:

I work with a number of packages that are heavily NIO-based. From the current documentation, I found it unclear how to create nested spans using this package in that environment where Task local variables were not preserved throughout EventLoopFuture chains.

Modifications:

This simply adds documentation for how to manually propogate spans by providing context arguments. It offers some examples that clarify that those contexts should come from started spans in order for trace IDs to be linked.

Result:

No functional changes, simply more thorough documentation.

Please let me know if I missed something or you have different suggestions!