[Evolve][Issue] Resolve issue 113

Close issue #113. Signed-off-by: Mark Van de Vyver <[email protected]>
tikv · Sep 13, 2023 · 04ae4a4 · 04ae4a4
1 parent 0ca8cc8
commit 04ae4a4
Show file tree

Hide file tree

Showing 208 changed files with 10,523 additions and 412 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -2,9 +2,9 @@ name: CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 env:
   CARGO_TERM_COLOR: always

diff --git a/.github/workflows/coverage.yml b/.github/workflows/coverage.yml
@@ -22,8 +22,6 @@ jobs:
           RUSTDOCFLAGS: "-Zprofile -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off"
         run: |
           cargo test --workspace --all-features --no-fail-fast
-          cargo run --example synchronous
-          cargo run --example asynchronous
           cargo run --example get_started
       - id: coverage
         uses: actions-rs/[email protected]

diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@
 
 .idea
 Cargo.lock
+*.log
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+- Refactor `minitrace-macro` to pipeline model (issue #113).
+- Issue #142: Attribute arguments are all keyword/named arguments. Position arguments deprecated.
+- Issue #128: Attribute parsing errors should not break IDE completion, etc.
+- Issue #112: Fixed
+
 ## v0.5.1
 
 - Fix panics due to destruction of Thread Local Storage value
@@ -19,7 +24,7 @@
 - Remove `LocalSpanGuard` and merge it into `LocalSpan`.
 - Remove `LocalSpan::with_property`, `LocalSpan::with_properties`, `Span::with_property` and `Span::with_properties`.
 - Add `LocalSpan::add_property`, `LocalSpan::add_properties`, `Span::add_property` and `Span::add_properties`.
-- Remove `LocalParentGuard`. `Span::set_local_parent` returns a general `Option<Guard<impl FnOnce()>>` instead. 
+- Remove `LocalParentGuard`. `Span::set_local_parent` returns a general `Option<Guard<impl FnOnce()>>` instead.
 
 ## v0.3.1
 

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,14 +1,92 @@
+[package]
+name = "minitrace"
+version = "0.5.1"
+authors = ["The TiKV Project Authors"]
+license = "Apache-2.0"
+rust-version = "1.56.0"
+edition = "2021"
+description = "A high-performance timeline tracing library for Rust"
+homepage = "https://github.com/tikv/minitrace-rust"
+repository = "https://github.com/tikv/minitrace-rust"
+documentation = "https://docs.rs/minitrace"
+readme = "README.md"
+keywords = ["tracing", "span", "datadog", "jaeger", "opentracing"]
+
 [workspace]
 resolver = "2"
 members = [
-    "minitrace",
     "minitrace-macro",
     "minitrace-jaeger",
     "minitrace-datadog",
     "minitrace-opentelemetry",
     "test-no-report",
+    "minitrace-tests",
 ]
+exclude = ["minitrace-old"]
+
+[dependencies]
+futures = "0.3"
+minitrace-macro = { version = "0.5.1", path = "minitrace-macro", optional = true}
+minstant = "0.1"
+parking_lot = "0.12"
+pin-project = "1.0"
+# TODO: Remove once_cell once #![feature(once_cell)] is stabilized
+once_cell = "1"
+rand = "0.8"
+
+[dev-dependencies]
+# The procedural macro `trace` only supports async-trait higher than 0.1.52
+async-trait = "0.1.52"
+criterion = { version = "0.3", features = ["html_reports"] }
+crossbeam = "0.8"
+env_logger = "0.10"
+futures = "0.3"
+futures-timer = "3"
+log = "0.4"
+logcall = "0.1.4"
+minitrace-datadog = { path = "minitrace-datadog" }
+minitrace-jaeger = { path = "minitrace-jaeger" }
+minitrace-opentelemetry = { version = "0.5.1", path = "minitrace-opentelemetry" }
+mockall = "0.11"
+once_cell = "1"
+opentelemetry = { version = "0.19", default-features = false, features = ["trace"] }
+opentelemetry-otlp = { version = "0.12", features = ["trace"] }
+rand = "0.8"
+rustracing = "0.6"
+serial_test = "2"
+test-harness = "0.1.1"
+tokio = { version = "1", features = ["rt", "time", "macros"] }
+tracing = "0.1"
+tracing-core = "0.1"
+tracing-opentelemetry = "0.15"
+tracing-subscriber = "0.2"
+
+# Cargo does not pass on features to subcrates in a virtual workspace
+# https://github.com/rust-lang/cargo/issues/4942
+#
+# Workaround:
+#
+#     export MINITRACE_FEATURES="default minitrace-tests/tk"
+#     cargo test --manifest-path=moniker/Cargo.toml --no-default-features --features="$MINITRACE_FEATURES" test-name
+#
+[features]
+default = ["attributes", "enable"]
+attributes = ["minitrace-macro"]
+ci = []
+enable = []
+
+[[bench]]
+name = "trace"
+harness = false
+
+[[bench]]
+name = "compare"
+harness = false
+
+[[bench]]
+name = "spsc"
+harness = false
 
-[profile.bench]
-opt-level = 3
-lto = true
+[[bench]]
+name = "object_pool"
+harness = false
diff --git a/minitrace/benches/compare.rs → benches/compare.rs b/minitrace/benches/compare.rs → benches/compare.rs
diff --git a/minitrace/benches/object_pool.rs → benches/object_pool.rs b/minitrace/benches/object_pool.rs → benches/object_pool.rs
diff --git a/minitrace/benches/spsc.rs → benches/spsc.rs b/minitrace/benches/spsc.rs → benches/spsc.rs
diff --git a/minitrace/benches/trace.rs → benches/trace.rs b/minitrace/benches/trace.rs → benches/trace.rs
diff --git a/minitrace/examples/asynchronous.rs → examples/asynchronous.rs b/minitrace/examples/asynchronous.rs → examples/asynchronous.rs
diff --git a/minitrace/examples/get_started.rs → examples/get_started.rs b/minitrace/examples/get_started.rs → examples/get_started.rs
@@ -1,5 +1,11 @@
 // Copyright 2022 TiKV Project Authors. Licensed under Apache-2.0.
-
+//! # Get started
+//!
+//! 1. Setup a trace viewer/frontend. Jaeger example:
+//!    ```ignore
+//!    podman run -p6831:6831/udp -p6832:6832/udp -p16686:16686 jaegertracing/all-in-one:latest
+//!    ```
+//!
 use minitrace::collector::Config;
 use minitrace::collector::ConsoleReporter;
 use minitrace::prelude::*;

diff --git a/minitrace/examples/log.rs → examples/log.rs b/minitrace/examples/log.rs → examples/log.rs
diff --git a/minitrace/examples/synchronous.rs → examples/synchronous.rs b/minitrace/examples/synchronous.rs → examples/synchronous.rs
diff --git a/minitrace/examples/unit_test.rs → examples/unit_test.rs b/minitrace/examples/unit_test.rs → examples/unit_test.rs
diff --git a/img/benchmark.jpeg b/img/benchmark.jpeg
@@ -0,0 +1 @@
+../../img/benchmark.jpeg
diff --git a/img/jaeger-asynchronous.png b/img/jaeger-asynchronous.png
@@ -0,0 +1 @@
+../../img/jaeger-asynchronous.png
diff --git a/img/jaeger-synchronous.png b/img/jaeger-synchronous.png
@@ -0,0 +1 @@
+../../img/jaeger-synchronous.png
diff --git a/minitrace-datadog/Cargo.toml b/minitrace-datadog/Cargo.toml
@@ -13,7 +13,7 @@ categories = ["development-tools::debugging"]
 keywords = ["tracing", "span", "datadog", "jaeger", "opentelemetry"]
 
 [dependencies]
-minitrace = { path = "../minitrace" }
+minitrace = { path = "../" }
 reqwest = { version = "0.11", features = ["blocking"] }
 rmp-serde = "1"
 serde = { version = "1", features = ["derive"] }

diff --git a/minitrace-jaeger/Cargo.toml b/minitrace-jaeger/Cargo.toml
@@ -14,7 +14,7 @@ keywords = ["tracing", "span", "datadog", "jaeger", "opentelemetry"]
 
 [dependencies]
 log = "0.4"
-minitrace = { path = "../minitrace" }
+minitrace = { path = "../" }
 thrift_codec = "0.2"
 
 [dev-dependencies]

diff --git a/minitrace-macro/Cargo.toml b/minitrace-macro/Cargo.toml
@@ -3,6 +3,7 @@ name = "minitrace-macro"
 version = "0.5.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
+rust-version = "1.56.0"
 edition = "2021"
 description = "Attribute procedural macro for minitrace-rust"
 homepage = "https://github.com/tikv/minitrace-rust"
@@ -16,17 +17,31 @@ keywords = ["tracing", "span", "datadog", "jaeger", "opentelemetry"]
 proc-macro = true
 
 [dependencies]
-# The macro `quote_spanned!` is added to syn in 1.0.84
+darling = "0.14"
 proc-macro-error = "1"
 proc-macro2 = "1"
 quote = "1"
-syn = { version = "1.0.84", features = ["full", "parsing", "extra-traits", "proc-macro", "visit-mut"] }
+# The macro `quote_spanned!` is added to syn in 1.0.84
+syn = { version = "1.0.84", features = ["full", "parsing", "extra-traits", "proc-macro", "visit", "visit-mut"] }
+thiserror = "1.0.30"
+tree-flat = "0.1.1"
 
 [dev-dependencies]
+aquamarine = "0.1"
+futures = "0.3"
+futures-timer = "3.0"
 logcall = "0.1.4"
-minitrace = { path = "../minitrace" }
+macrotest = "1"
+minitrace = { path = "../" }
+minitrace-jaeger  = { path = "../minitrace-jaeger" }
+rand = "0.8"
+test-utilities = { path = "../test-utilities" }
 tokio = { version = "1", features = ["full"] }
 trybuild = "1"
 # The procedural macro `trace` only supports async-trait higher than 0.1.52
 async-trait = "0.1.52"
 log = "0.4"
+
+[features]
+default = []
+ci = []