From 40889d141e9127eb4657f1e5c0780e4220747afc Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Tue, 13 Dec 2022 22:08:04 +0900 Subject: [PATCH 1/3] notes about LoggingContext --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index af37f765..ca65b04a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,9 @@ This is a collection of Swift libraries enabling the instrumentation of server s While Swift Distributed Tracing allows building all kinds of _instruments_, which can co-exist in applications transparently, its primary use is instrumenting multi-threaded and distributed systems with Distributed Traces. +> Warning: The docs below, showcasing the 0.3.x series of the logging integration are **deprecated** thanks to the latest inclusion of [metadata providers in swift-log](https://github.com/apple/swift-log/pull/238). Thanks to the introduction of task local values in Swift, and metadata providers in swift-log, the `LoggingContext` pattern showcased below has become an _anti-pattern_. Please give us a moment to finish the [new documentation PR #69](https://github.com/apple/swift-distributed-tracing/pull/69) which will explain the new integration style. +> +> Tracer APIs will not change substancially, as we're closing up on announcing a 1.0 very soon. Please look forward to beta releases very soon! --- From 56e929f8d072c96a46fc4612362c7c06912ff650 Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Tue, 13 Dec 2022 22:09:07 +0900 Subject: [PATCH 2/3] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ca65b04a..0bbb7c27 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This is a collection of Swift libraries enabling the instrumentation of server s While Swift Distributed Tracing allows building all kinds of _instruments_, which can co-exist in applications transparently, its primary use is instrumenting multi-threaded and distributed systems with Distributed Traces. -> Warning: The docs below, showcasing the 0.3.x series of the logging integration are **deprecated** thanks to the latest inclusion of [metadata providers in swift-log](https://github.com/apple/swift-log/pull/238). Thanks to the introduction of task local values in Swift, and metadata providers in swift-log, the `LoggingContext` pattern showcased below has become an _anti-pattern_. Please give us a moment to finish the [new documentation PR #69](https://github.com/apple/swift-distributed-tracing/pull/69) which will explain the new integration style. +> Warning: The docs below, showcasing the 0.3.x series of the logging integration are **deprecated** thanks to the latest inclusion of [metadata providers in swift-log](https://github.com/apple/swift-log/pull/238). Thanks to the introduction of [task local values in Swift](https://developer.apple.com/documentation/swift/tasklocal), and metadata providers in swift-log, the `LoggingContext` pattern showcased below has become an _anti-pattern_. Please give us a moment to finish the [new documentation PR #69](https://github.com/apple/swift-distributed-tracing/pull/69) which will explain the new integration style. > > Tracer APIs will not change substancially, as we're closing up on announcing a 1.0 very soon. Please look forward to beta releases very soon! From cbd759e5e18dc2ced4c3bbbcc08a17b20ba0f804 Mon Sep 17 00:00:00 2001 From: Konrad `ktoso` Malawski Date: Wed, 14 Dec 2022 14:05:58 +0900 Subject: [PATCH 3/3] Apply suggestions from code review Co-authored-by: Yim Lee --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0bbb7c27..8e67175b 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ This is a collection of Swift libraries enabling the instrumentation of server s While Swift Distributed Tracing allows building all kinds of _instruments_, which can co-exist in applications transparently, its primary use is instrumenting multi-threaded and distributed systems with Distributed Traces. -> Warning: The docs below, showcasing the 0.3.x series of the logging integration are **deprecated** thanks to the latest inclusion of [metadata providers in swift-log](https://github.com/apple/swift-log/pull/238). Thanks to the introduction of [task local values in Swift](https://developer.apple.com/documentation/swift/tasklocal), and metadata providers in swift-log, the `LoggingContext` pattern showcased below has become an _anti-pattern_. Please give us a moment to finish the [new documentation PR #69](https://github.com/apple/swift-distributed-tracing/pull/69) which will explain the new integration style. +> Warning: The docs below, showcasing the 0.3.x series of the logging integration are **deprecated** thanks to the latest inclusion of [metadata providers in swift-log](https://github.com/apple/swift-log/pull/238). With the introduction of [task local values in Swift](https://developer.apple.com/documentation/swift/tasklocal), and metadata providers in swift-log, the `LoggingContext` pattern showcased below has become an _anti-pattern_. Please give us a moment to finish the [new documentation PR #69](https://github.com/apple/swift-distributed-tracing/pull/69), which will explain the new integration style in detail. > -> Tracer APIs will not change substancially, as we're closing up on announcing a 1.0 very soon. Please look forward to beta releases very soon! +> Tracer APIs will not change substantially, as we're closing up on announcing version 1.0. Please look forward to beta releases very soon! ---