]> git.proxmox.com Git - rustc.git/blob - vendor/tracing-attributes/CHANGELOG.md
New upstream version 1.64.0+dfsg1
[rustc.git] / vendor / tracing-attributes / CHANGELOG.md
1 # 0.1.22 (July 1, 2022)
2
3 This release fixes an issue where using the `err` or `ret` arguments to
4 `#[instrument]` along with an overridden target, such as
5
6 ```rust
7 #[instrument(target = "...", err, ret)]
8 ```
9
10 would not propagate the overridden target to the events generated for
11 errors/return values.
12
13 ### Fixed
14
15 - Error and return value events generated by `#[instrument(err)]` or
16 `#[instrument(ret)]` not inheriting an overridden target ([#2184])
17 - Incorrect default level in documentation ([#2119])
18
19 Thanks to new contributor @tbraun96 for contributing to this release!
20
21 [#2184]: https://github.com/tokio-rs/tracing/pull/2184
22 [#2119]: https://github.com/tokio-rs/tracing/pull/2119
23
24 # 0.1.21 (April 26, 2022)
25
26 This release adds support for setting explicit parent and follows-from spans
27 in the `#[instrument]` attribute.
28
29 ### Added
30
31 - `#[instrument(follows_from = ...)]` argument for setting one or more
32 follows-from span ([#2093])
33 - `#[instrument(parent = ...)]` argument for overriding the generated span's
34 parent ([#2091])
35
36 ### Fixed
37
38 - Extra braces around `async` blocks in expanded code (causes a Clippy warning)
39 ([#2090])
40 - Broken documentation links ([#2068], [#2077])
41
42 Thanks to @jarrodldavis, @ben0x539, and new contributor @jswrenn for
43 contributing to this release!
44
45
46 [#2093]: https://github.com/tokio-rs/tracing/pull/2093
47 [#2091]: https://github.com/tokio-rs/tracing/pull/2091
48 [#2090]: https://github.com/tokio-rs/tracing/pull/2090
49 [#2077]: https://github.com/tokio-rs/tracing/pull/2077
50 [#2068]: https://github.com/tokio-rs/tracing/pull/2068
51
52 # 0.1.20 (March 8, 2022)
53
54 ### Fixed
55
56 - Compilation failure with `--minimal-versions` due to a too-permissive `syn`
57 dependency ([#1960])
58
59 ### Changed
60
61 - Bumped minimum supported Rust version (MSRV) to 1.49.0 ([#1913])
62
63 Thanks to new contributor @udoprog for contributing to this release!
64
65 [#1960]: https://github.com/tokio-rs/tracing/pull/1960
66 [#1913]: https://github.com/tokio-rs/tracing/pull/1913
67
68 # 0.1.19 (February 3, 2022)
69
70 This release introduces a new `#[instrument(ret)]` argument to emit an event
71 with the return value of an instrumented function.
72
73 ### Added
74
75 - `#[instrument(ret)]` to record the return value of a function ([#1716])
76 - added `err(Debug)` argument to cause `#[instrument(err)]` to record errors
77 with `Debug` rather than `Display ([#1631])
78
79 ### Fixed
80
81 - incorrect code generation for functions returning async blocks ([#1866])
82 - incorrect diagnostics when using `rust-analyzer` ([#1634])
83
84 Thanks to @Swatinem, @hkmatsumoto, @cynecx, and @ciuncan for contributing to
85 this release!
86
87 [#1716]: https://github.com/tokio-rs/tracing/pull/1716
88 [#1631]: https://github.com/tokio-rs/tracing/pull/1631
89 [#1634]: https://github.com/tokio-rs/tracing/pull/1634
90 [#1866]: https://github.com/tokio-rs/tracing/pull/1866
91
92 # 0.1.18 (October 5, 2021)
93
94 This release fixes issues introduced in v0.1.17.
95
96 ### Fixed
97
98 - fixed mismatched types compiler error that may occur when using
99 `#[instrument]` on an `async fn` that returns an `impl Trait` value that
100 includes a closure ([#1616])
101 - fixed false positives for `clippy::suspicious_else_formatting` warnings due to
102 rust-lang/rust-clippy#7760 and rust-lang/rust-clippy#6249 ([#1617])
103 - fixed `clippy::let_unit_value` lints when using `#[instrument]` ([#1614])
104
105 [#1617]: https://github.com/tokio-rs/tracing/pull/1617
106 [#1616]: https://github.com/tokio-rs/tracing/pull/1616
107 [#1614]: https://github.com/tokio-rs/tracing/pull/1614
108
109 # 0.1.17 (YANKED) (October 1, 2021)
110
111 This release significantly improves performance when `#[instrument]`-generated
112 spans are below the maximum enabled level.
113
114 ### Added
115
116 - improve performance when skipping `#[instrument]`-generated spans below the
117 max level ([#1600], [#1605])
118
119 Thanks to @oli-obk for contributing to this release!
120
121 [#1600]: https://github.com/tokio-rs/tracing/pull/1600
122 [#1605]: https://github.com/tokio-rs/tracing/pull/1605
123
124 # 0.1.16 (September 13, 2021)
125
126 This release adds a new `#[instrument(skip_all)]` option to skip recording *all*
127 arguments to an instrumented function as fields. Additionally, it adds support
128 for recording arguments that are `tracing` primitive types as typed values,
129 rather than as `fmt::Debug`.
130
131 ### Added
132
133 - add `skip_all` option to `#[instrument]` ([#1548])
134 - record primitive types as primitive values rather than as `fmt::Debug`
135 ([#1378])
136 - added support for `f64`s as typed values ([#1522])
137
138 Thanks to @Folyd and @jsgf for contributing to this release!
139
140 [#1548]: https://github.com/tokio-rs/tracing/pull/1548
141 [#1378]: https://github.com/tokio-rs/tracing/pull/1378
142 [#1522]: https://github.com/tokio-rs/tracing/pull/1524
143
144 # 0.1.15 (March 12, 2021)
145
146 ### Fixed
147
148 - `#[instrument]` on functions returning `Box::pin`ned futures incorrectly
149 skipping function bodies prior to returning a future ([#1297])
150
151 Thanks to @nightmared for contributing to this release!
152
153 [#1297]: https://github.com/tokio-rs/tracing/pull/1297
154
155 # 0.1.14 (March 10, 2021)
156
157 ### Fixed
158
159 - Compatibility between `#[instrument]` and `async-trait` v0.1.43 and newer
160 ([#1228])
161
162 Thanks to @nightmared for lots of hard work on this fix!
163
164 [#1228]: https://github.com/tokio-rs/tracing/pull/1228
165
166 # 0.1.13 (February 17, 2021)
167
168 ### Fixed
169
170 - Compiler error when using `#[instrument(err)]` on functions which return `impl
171 Trait` ([#1236])
172
173 [#1236]: https://github.com/tokio-rs/tracing/pull/1236
174
175 # 0.1.12 (February 4, 2021)
176
177 ### Fixed
178
179 - Compiler error when using `#[instrument(err)]` on functions with mutable
180 parameters ([#1167])
181 - Missing function visibility modifier when using `#[instrument]` with
182 `async-trait` ([#977])
183 - Multiple documentation fixes and improvements ([#965], [#981], [#1215])
184
185 ### Changed
186
187 - `tracing-futures` dependency is no longer required when using `#[instrument]`
188 on async functions ([#808])
189
190 Thanks to @nagisa, @Txuritan, @TaKO8Ki, and @okready for contributing to this
191 release!
192
193 [#1167]: https://github.com/tokio-rs/tracing/pull/1167
194 [#977]: https://github.com/tokio-rs/tracing/pull/977
195 [#965]: https://github.com/tokio-rs/tracing/pull/965
196 [#981]: https://github.com/tokio-rs/tracing/pull/981
197 [#1215]: https://github.com/tokio-rs/tracing/pull/1215
198 [#808]: https://github.com/tokio-rs/tracing/pull/808
199
200 # 0.1.11 (August 18, 2020)
201
202 ### Fixed
203
204 - Corrected wrong minimum supported Rust version note in docs (#941)
205 - Removed unused `syn` features (#928)
206
207 Thanks to new contributor @jhpratt for contributing to this release!
208
209 # 0.1.10 (August 10, 2020)
210
211 ### Added
212
213 - Support for using `self` in field expressions when instrumenting `async-trait`
214 functions (#875)
215 - Several documentation improvements (#832, #897, #911, #913)
216
217 Thanks to @anton-dutov and @nightmared for contributing to this release!
218
219 # 0.1.9 (July 8, 2020)
220
221 ### Added
222
223 - Support for arbitrary expressions as fields in `#[instrument]` (#672)
224
225 ### Changed
226
227 - `#[instrument]` now emits a compiler warning when ignoring unrecognized
228 input (#672, #786)
229
230 # 0.1.8 (May 13, 2020)
231
232 ### Added
233
234 - Support for using `#[instrument]` on methods that are part of [`async-trait`]
235 trait implementations (#711)
236 - Optional `#[instrument(err)]` argument to automatically emit an event if an
237 instrumented function returns `Err` (#637)
238
239 Thanks to @ilana and @nightmared for contributing to this release!
240
241 [`async-trait`]: https://crates.io/crates/async-trait
242
243 # 0.1.7 (February 26, 2020)
244
245 ### Added
246
247 - Support for adding arbitrary literal fields to spans generated by
248 `#[instrument]` (#569)
249 - `#[instrument]` now emits a helpful compiler error when attempting to skip a
250 function parameter (#600)
251
252 Thanks to @Kobzol for contributing to this release!
253
254 # 0.1.6 (December 20, 2019)
255
256 ### Added
257
258 - Updated documentation (#468)
259
260 # 0.1.5 (October 22, 2019)
261
262 ### Added
263
264 - Support for destructuring in arguments to `#[instrument]`ed functions (#397)
265 - Generated field for `self` parameters when `#[instrument]`ing methods (#397)
266
267 # 0.1.4 (September 26, 2019)
268
269 ### Added
270
271 - Optional `skip` argument to `#[instrument]` for excluding function parameters
272 from generated spans (#359)
273
274 # 0.1.3 (September 12, 2019)
275
276 ### Fixed
277
278 - Fixed `#[instrument]`ed async functions not compiling on `nightly-2019-09-11`
279 or newer (#342)
280
281 # 0.1.2 (August 19, 2019)
282
283 ### Changed
284
285 - Updated `syn` and `quote` dependencies to 1.0 (#292)
286 - Removed direct dependency on `proc-macro2` to avoid potential version
287 conflicts (#296)
288
289 ### Fixed
290
291 - Outdated idioms in examples (#271, #273)
292
293 # 0.1.1 (August 9, 2019)
294
295 ### Changed
296
297 - Using the `#[instrument]` attribute on `async fn`s no longer requires a
298 feature flag (#258)
299
300 ### Fixed
301
302 - The `#[instrument]` macro now works on generic functions (#262)
303
304 # 0.1.0 (August 8, 2019)
305
306 - Initial release