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

API stability information (1.0.0) #61

Closed wolverian closed 2 years ago

wolverian commented 2 years ago

Do you have stability guarantees for this package, and/or guidance for library authors when they should add support for tracing in their stable releases?

ktoso commented 2 years ago

Hi there, Thanks for the question :-)

As you'll notice by the version numbers the package is in a pre-1.0 phase, so there's no strong stability guarantees yet.

Having that said, with WWDC behind us, some of us are becoming more free again to work on this package again and focus on its stabilization. I can't commit to an exact timeline, but we expect to work on hitting the 1.0 relatively soon...

I posted a similar update here on the forums: https://forums.swift.org/t/road-to-tracing-1-0/54160/6

Since then we have resumed active work on some remaining things, including otel attributes with @slashmo and as soon as we figure out the swift-log integration I think we'll be able to call a 1.0.

What's the use case where you're seeking to adopt and what guidance were you missing from the existing "In-Depth Guide for: Library/Framework developers part of the readme?

wolverian commented 2 years ago

As you'll notice by the version numbers the package is in a pre-1.0 phase, so there's no strong stability guarantees yet.

I think this is enough information for now. I asked mainly for Vapor. Thank you for the reply!