feat: add #[trace(full_path = true)]

Signed-off-by: Andy Lok <[email protected]>

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+## v0.6.1
+
+- Add macro attribute `#[trace(full_path = true)]` to use the full path of the function instead of only the function name.
+
 ## v0.6.0
 
 - Span name and event name now accept both `&'static str` and `String` (`Into<Cow<'static, str>>`), which previously only accept `&'static str`.

minitrace-datadog/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "minitrace-datadog"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
 edition = "2021"

minitrace-jaeger/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "minitrace-jaeger"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
 edition = "2021"

minitrace-macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "minitrace-macro"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
 edition = "2021"

minitrace-macro/src/lib.rs

@@ -19,18 +19,24 @@ use syn::spanned::Spanned;
 use syn::*;
 
 struct Args {
-    name: String,
+    name: Name,
     enter_on_poll: bool,
 }
 
+enum Name {
+    Function(String),
+    FullPath,
+}
+
 impl Args {
-    fn parse(default_name: String, input: AttributeArgs) -> Args {
+    fn parse(func_name: String, input: AttributeArgs) -> Args {
         if input.len() > 2 {
             abort_call_site!("too many arguments");
         }
 
         let mut args = HashSet::new();
-        let mut name = default_name;
+        let mut func_name = func_name;
+        let mut full_path = false;
         let mut enter_on_poll = false;
 
         for arg in &input {
@@ -40,9 +46,17 @@ impl Args {
                     lit: Lit::Str(s),
                     ..
                 })) if path.is_ident("name") => {
-                    name = s.value();
+                    func_name = s.value();
                     args.insert("name");
                 }
+                NestedMeta::Meta(Meta::NameValue(MetaNameValue {
+                    path,
+                    lit: Lit::Bool(b),
+                    ..
+                })) if path.is_ident("full_path") => {
+                    full_path = b.value;
+                    args.insert("full_path");
+                }
                 NestedMeta::Meta(Meta::NameValue(MetaNameValue {
                     path,
                     lit: Lit::Bool(b),
@@ -55,6 +69,15 @@ impl Args {
             }
         }
 
+        let name = if full_path {
+            if args.contains("name") {
+                abort_call_site!("`name` and `full_path` can not be used together");
+            }
+            Name::FullPath
+        } else {
+            Name::Function(func_name)
+        };
+
         if args.len() != input.len() {
             abort_call_site!("duplicated arguments");
         }
@@ -74,6 +97,13 @@ impl Args {
 /// The `#[trace]` attribute requires a local parent context to function correctly. Ensure that
 /// the function annotated with `#[trace]` is called within the scope of `Span::set_local_parent()`.
 ///
+/// ## Arguments
+///
+/// * `name` - The name of the span. Defaults to the function name.
+/// * `full_path` - Whether to use the full path of the function as the span name. Defaults to `false`.
+/// * `enter_on_poll` - Whether to enter the span on poll, if set to `false`, `in_span` will be used.
+///    Only available for `async fn`. Defaults to `false`.
+///
 /// # Examples
 ///
 /// ```
@@ -205,7 +235,7 @@ fn gen_block(
     async_keyword: bool,
     args: Args,
 ) -> proc_macro2::TokenStream {
-    let name = args.name;
+    let name = gen_name(block.span(), args.name);
 
     // Generate the instrumented function body.
     // If the function is an `async fn`, this will wrap it in an async block.
@@ -246,6 +276,25 @@ fn gen_block(
     }
 }
 
+fn gen_name(span: proc_macro2::Span, name: Name) -> proc_macro2::TokenStream {
+    match name {
+        Name::Function(func_name) => quote_spanned!(span=>
+            #func_name
+        ),
+        Name::FullPath => quote_spanned!(span=>
+            {
+                fn f() {}
+                fn type_name_of<T>(_: T) -> &'static str {
+                    std::any::type_name::<T>()
+                }
+                let name = type_name_of(f);
+                let name = &name[..name.len() - 3];
+                name.trim_end_matches("::{{closure}}")
+            }
+        ),
+    }
+}
+
 enum AsyncTraitKind<'a> {
     // old construction. Contains the function
     Function(&'a ItemFn),

minitrace-macro/tests/ui/err/has-enter-on-poll-and-sync.rs

@@ -0,0 +1,6 @@
+use minitrace::trace;
+
+#[trace(enter_on_poll = true)]
+fn f() {}
+
+fn main() {}

minitrace-macro/tests/ui/err/has-enter-on-poll-and-sync.stderr

@@ -0,0 +1,7 @@
+error: `enter_on_poll` can not be applied on non-async function
+ --> tests/ui/err/has-enter-on-poll-and-sync.rs:3:1
+  |
+3 | #[trace(enter_on_poll = true)]
+  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  |
+  = note: this error originates in the attribute macro `trace` (in Nightly builds, run with -Z macro-backtrace for more info)

minitrace-macro/tests/ui/err/has-name-and-full-path.rs

@@ -0,0 +1,6 @@
+use minitrace::trace;
+
+#[trace(name = "Name", full_path = true)]
+fn f() {}
+
+fn main() {}

minitrace-macro/tests/ui/err/has-name-and-full-path.stderr

@@ -0,0 +1,7 @@
+error: `name` and `full_path` can not be used together
+ --> tests/ui/err/has-name-and-full-path.rs:3:1
+  |
+3 | #[trace(name = "Name", full_path = true)]
+  | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  |
+  = note: this error originates in the attribute macro `trace` (in Nightly builds, run with -Z macro-backtrace for more info)

minitrace-macro/tests/ui/ok/has-enter-on-poll.rs

@@ -0,0 +1,11 @@
+use minitrace::trace;
+
+#[trace(enter_on_poll = true)]
+async fn f(a: u32) -> u32 {
+    a
+}
+
+#[tokio::main]
+async fn main() {
+    f(1).await;
+}

minitrace-macro/tests/ui/ok/has-full-path.rs

@@ -0,0 +1,11 @@
+use minitrace::trace;
+
+#[trace(full_path = true)]
+async fn f(a: u32) -> u32 {
+    a
+}
+
+#[tokio::main]
+async fn main() {
+    f(1).await;
+}

minitrace-macro/tests/ui/ok/has-name-and-full-path.rs

@@ -0,0 +1,11 @@
+use minitrace::trace;
+
+#[trace(name = "Name", full_path = false)]
+async fn f(a: u32) -> u32 {
+    a
+}
+
+#[tokio::main]
+async fn main() {
+    f(1).await;
+}

minitrace-opentelemetry/Cargo.toml

@@ -1,10 +1,10 @@
 [package]
 name = "minitrace-opentelemetry"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
 edition = "2021"
-description = "Jaeger reporter for minitrace-rust"
+description = "Opentelemetry reporter for minitrace-rust"
 homepage = "https://github.com/tikv/minitrace-rust"
 repository = "https://github.com/tikv/minitrace-rust"
 documentation = "https://docs.rs/minitrace-jaeger"

minitrace/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "minitrace"
-version = "0.6.0"
+version = "0.6.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
 edition = "2021"
@@ -17,7 +17,7 @@ enable = []
 
 [dependencies]
 futures = "0.3"
-minitrace-macro = { version = "0.6.0", path = "../minitrace-macro" }
+minitrace-macro = { version = "0.6.1", path = "../minitrace-macro" }
 minstant = "0.1"
 parking_lot = "0.12"
 pin-project = "1"
@@ -37,9 +37,9 @@ futures-timer = "3"
 log = "0.4"
 logcall = "0.1.4"
 minitrace = { path = ".", features = ["enable"] }
-minitrace-datadog = { version = "0.6.0", path = "../minitrace-datadog" }
-minitrace-jaeger = { version = "0.6.0", path = "../minitrace-jaeger" }
-minitrace-opentelemetry = { version = "0.6.0", path = "../minitrace-opentelemetry" }
+minitrace-datadog = { version = "0.6.1", path = "../minitrace-datadog" }
+minitrace-jaeger = { version = "0.6.1", path = "../minitrace-jaeger" }
+minitrace-opentelemetry = { version = "0.6.1", path = "../minitrace-opentelemetry" }
 mockall = "0.11"
 once_cell = "1"
 opentelemetry = { version = "0.20", features = ["trace"] }

minitrace/src/lib.rs

@@ -305,9 +305,6 @@
 //! [`Future`]: std::future::Future
 
 // Suppress a false-positive lint from clippy
-// TODO: remove me once https://github.com/rust-lang/rust-clippy/issues/11076 is released
-#![allow(unknown_lints)]
-#![allow(clippy::arc_with_non_send_sync)]
 #![allow(clippy::needless_doctest_main)]
 #![cfg_attr(not(feature = "enable"), allow(dead_code))]
 #![cfg_attr(not(feature = "enable"), allow(unused_mut))]

minitrace/tests/lib.rs

@@ -486,6 +486,16 @@ fn macro_example() {
         futures_timer::Delay::new(std::time::Duration::from_millis(i)).await;
     }
 
+    #[trace(full_path = true)]
+    fn do_something_full_path(i: u64) {
+        std::thread::sleep(std::time::Duration::from_millis(i));
+    }
+
+    #[trace(full_path = true)]
+    async fn do_something_async_full_path(i: u64) {
+        futures_timer::Delay::new(std::time::Duration::from_millis(i)).await;
+    }
+
     let (reporter, collected_spans) = TestReporter::new();
     minitrace::set_reporter(reporter, Config::default());
 
@@ -494,6 +504,8 @@ fn macro_example() {
         let _g = root.set_local_parent();
         do_something(100);
         block_on(do_something_async(100));
+        do_something_full_path(100);
+        block_on(do_something_async_full_path(100));
     }
 
     minitrace::flush();
@@ -502,6 +514,8 @@ fn macro_example() {
 root []
     do_something []
     do_something_async []
+    lib::macro_example::{{closure}}::do_something_async_full_path []
+    lib::macro_example::{{closure}}::do_something_full_path []
 "#;
     assert_eq!(
         tree_str_from_span_records(collected_spans.lock().clone()),