Simplify common case of immediately entering the span #1252

matklad · 2021-02-19T08:47:42Z

This PR allows the following API:

let _guard = tracing::span!("foo").entered();

See https://github.com/tokio-rs/tracing/issues/zc for an extended
discussion.

This probably needs better docs, so that the people know that this API exists, but I would prefer to avoid further polishing the docs myself :)

Closes #1246
Closes #192
Closes #79

This PR allows the following API: ``` let _guard = tracing::span!("foo").entered(); ``` See tokio-rs#1246 for an extended discussion.

This fns are monomorphic, so an `#[inline]` is necessary to alow cross-crate inlining at all.

hawkw

This looks great! I went ahead and added a suggestion with some more complete documentation, based on the existing ones for enter.

Once this PR merges, I'll go ahead and backport it to v0.1.x as well. We may also want to make some of the existing examples more concise by using entered instead of enter, but that's probably better off as a follow-up.

Thanks for working on this!

tracing/src/span.rs

hawkw · 2021-02-19T18:54:35Z

tracing/src/span.rs

+    pub fn exit(mut self) -> Span {
+        // One does not simply move out of a struct with `Drop`.
+        let span = mem::replace(&mut self.span, Span::none());
+        span.do_exit();


That this will call do_exit again on Span::none() when the EnteredSpan drops at the end of the method, but that should just nop, since it's now None. Might be worth a comment noting that, but it's not really a blocker.

Yeah, I thought about doing

let me = ManuallyDrop::new(me); mem::replace(&mut me, Span::none()).do_exit();

but figured that a simple implementation withe the generic "tricky bit" comment would be overall better. The drop behavior is checked by the test, so it is unlikely to regress.

hawkw · 2021-02-19T18:55:15Z

tracing/src/span.rs

+impl Deref for EnteredSpan {
+    type Target = Span;
+
+    #[inline]
+    fn deref(&self) -> &Span {
+        &self.span
+    }
+}


tracing/src/span.rs

hawkw · 2021-02-19T19:18:09Z

This also closes #192 and #79. I updated the PR description to add those issues as well.

matklad · 2021-02-19T19:21:43Z

Once this PR merges, I'll go ahead and backport it to v0.1.x as well.

That'd be great, thanks!

hawkw

whoops, i made a couple mistakes in the doctests...this is what i get for trying to write examples directly in the github web UI rather than checking out the branch :/

tracing/src/span.rs

my bad!

tracing/src/span.rs

* Simplify common case of immediately entering the span This PR allows the following API: ``` let _guard = tracing::span!("foo").entered(); ``` See #1246 for an extended discussion. * Add missing inlines This fns are monomorphic, so an `#[inline]` is necessary to alow cross-crate inlining at all. * improve method documentation Co-authored-by: Eliza Weisman <eliza@buoyant.io> Signed-off-by: Eliza Weisman <eliza@buoyant.io>

@matklad

Added - `Span::entered` method for entering a span and moving it into a guard by value rather than borrowing it (#1252) Thanks to @matklad for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>

@matklad

Added - `Span::entered` method for entering a span and moving it into a guard by value rather than borrowing it (#1252) Thanks to @matklad for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>

@matklad

Added - `Span::entered` method for entering a span and moving it into a guard by value rather than borrowing it (#1252) Thanks to @matklad for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>

3542: Bump tracing from 0.1.22 to 0.1.25 r=mergify[bot] a=dependabot[bot] Bumps [tracing](https://github.com/tokio-rs/tracing) from 0.1.22 to 0.1.25. <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/tokio-rs/tracing/commit/4ad1e62a2dd9f3e97a06ead14285993a9df99ea5"><code>4ad1e62</code></a> tracing: prepare to release v0.1.25</li> <li><a href="https://github.com/tokio-rs/tracing/commit/c22b62e28121b66522beeff516f8a1528ec8ff36"><code>c22b62e</code></a> tracing: highlight <code>Span::entered</code> in more docs</li> <li><a href="https://github.com/tokio-rs/tracing/commit/a358728b1ef321751acead4580643b1150863c62"><code>a358728</code></a> tracing: simplify common case of immediately entering the span (<a href="https://github.com/tokio-rs/tracing/issues/1252">#1252</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/4538d74d228e4a6856c0176ade5f01fc26129b8e"><code>4538d74</code></a> subscriber: prepare to release v0.2.16 (<a href="https://github.com/tokio-rs/tracing/issues/1256">#1256</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/a0201ba798b86739ba633d15d297ec233b905e4e"><code>a0201ba</code></a> log: prepare to release v0.1.2</li> <li><a href="https://github.com/tokio-rs/tracing/commit/0cdd5e88ac3478ae91223e9c3b53a1c3598a7893"><code>0cdd5e8</code></a> log: forward <code>LogTracer::enabled</code> to the subscriber (<a href="https://github.com/tokio-rs/tracing/issues/1254">#1254</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/8d83326a5fddfdd68dc8865680f8663dad76a2b4"><code>8d83326</code></a> subscriber: fix FmtCollector not forwarding max level (<a href="https://github.com/tokio-rs/tracing/issues/1251">#1251</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/31aa6afecc1fb97b1f2d4eb15cefdd456c120142"><code>31aa6af</code></a> subscriber: set the max <code>log</code> <code>LevelFilter</code> in <code>init</code> (<a href="https://github.com/tokio-rs/tracing/issues/1248">#1248</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/2a9d17f73f8499b7e73cf6e8bee225190aac6990"><code>2a9d17f</code></a> log: compare <code>log</code> record <code>Level</code>s against the max level (<a href="https://github.com/tokio-rs/tracing/issues/1247">#1247</a>)</li> <li><a href="https://github.com/tokio-rs/tracing/commit/d173c2de9af913e2b4ebb8555e46d65b416ca730"><code>d173c2d</code></a> tracing: prepare to release v0.1.24 (<a href="https://github.com/tokio-rs/tracing/issues/1244">#1244</a>)</li> <li>Additional commits viewable in <a href="https://github.com/tokio-rs/tracing/compare/tracing-0.1.22...tracing-0.1.25">compare view</a></li> </ul> </details> <br /> [![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=tracing&package-manager=cargo&previous-version=0.1.22&new-version=0.1.25)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually </details> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…-rs#1252) * Simplify common case of immediately entering the span This PR allows the following API: ``` let _guard = tracing::span!("foo").entered(); ``` See tokio-rs#1246 for an extended discussion. * Add missing inlines This fns are monomorphic, so an `#[inline]` is necessary to alow cross-crate inlining at all. * improve method documentation Co-authored-by: Eliza Weisman <eliza@buoyant.io> Signed-off-by: Eliza Weisman <eliza@buoyant.io>

@matklad

Added - `Span::entered` method for entering a span and moving it into a guard by value rather than borrowing it (tokio-rs#1252) Thanks to @matklad for contributing to this release! Signed-off-by: Eliza Weisman <eliza@buoyant.io>

matklad requested review from davidbarsky, hawkw and a team as code owners February 19, 2021 08:47

Simplify common case of immediately entering the span

adf651e

This PR allows the following API: ``` let _guard = tracing::span!("foo").entered(); ``` See tokio-rs#1246 for an extended discussion.

matklad force-pushed the entered_span branch from 0f181f6 to adf651e Compare February 19, 2021 08:48

Add missing inlines

9effa13

This fns are monomorphic, so an `#[inline]` is necessary to alow cross-crate inlining at all.

matklad mentioned this pull request Feb 19, 2021

feat: add tracing infrastructure to contract runtime near/nearcore#3974

Merged

hawkw approved these changes Feb 19, 2021

View reviewed changes

Merge branch 'master' into entered_span

4ad1a65

hawkw self-assigned this Feb 19, 2021

improve method documentation

d9faab0

hawkw reviewed Feb 19, 2021

View reviewed changes

tracing/src/span.rs Outdated Show resolved Hide resolved

tracing/src/span.rs Outdated Show resolved Hide resolved

tracing/src/span.rs Show resolved Hide resolved

Fix doctest mistakes

c4f2f74

my bad!

hawkw reviewed Feb 19, 2021

View reviewed changes

tracing/src/span.rs Outdated Show resolved Hide resolved

hawkw added 3 commits February 19, 2021 13:03

missing semicolon

49fafdb

Merge branch 'master' into entered_span

e64868e

Merge branch 'master' into entered_span

6b339bd

hawkw merged commit 02f3074 into tokio-rs:master Feb 19, 2021

matklad deleted the entered_span branch February 19, 2021 22:08

sagebind mentioned this pull request Feb 20, 2021

Update requests to use non-contextual entered spans sagebind/isahc#304

Open

hawkw mentioned this pull request Feb 22, 2021

tracing: simplify common case of immediately entering the span (#1252) #1259

Merged

hawkw mentioned this pull request Feb 23, 2021

tracing: prepare to release v0.1.25 #1263

Merged

dependabot bot mentioned this pull request Mar 17, 2021

Bump tracing from 0.1.22 to 0.1.25 comit-network/comit-rs#3542

Merged

davidbarsky mentioned this pull request Sep 26, 2023

chore: backport roughly a year's worth of changes #2728

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Simplify common case of immediately entering the span #1252

Simplify common case of immediately entering the span #1252

matklad commented Feb 19, 2021 •

edited by hawkw

Loading

hawkw left a comment

hawkw Feb 19, 2021

matklad Feb 19, 2021

hawkw Feb 19, 2021

hawkw commented Feb 19, 2021

matklad commented Feb 19, 2021

hawkw left a comment

Simplify common case of immediately entering the span #1252

Simplify common case of immediately entering the span #1252

Conversation

matklad commented Feb 19, 2021 • edited by hawkw Loading

hawkw left a comment

Choose a reason for hiding this comment

hawkw Feb 19, 2021

Choose a reason for hiding this comment

matklad Feb 19, 2021

Choose a reason for hiding this comment

hawkw Feb 19, 2021

Choose a reason for hiding this comment

hawkw commented Feb 19, 2021

matklad commented Feb 19, 2021

hawkw left a comment

Choose a reason for hiding this comment

matklad commented Feb 19, 2021 •

edited by hawkw

Loading