chore: specify format rules (#149)

* chore: prefer to omit span name Signed-off-by: Andy Lok <andylokandy@hotmail.com> * add: example of integrating log Signed-off-by: Andy Lok <andylokandy@hotmail.com> * fix a false-alarm lint Signed-off-by: Andy Lok <andylokandy@hotmail.com> * fix a false-alarm lint again Signed-off-by: Andy Lok <andylokandy@hotmail.com> * chore: specify format rules Signed-off-by: Andy Lok <andylokandy@hotmail.com> * resolve ci Signed-off-by: Andy Lok <andylokandy@hotmail.com> * resolve ci Signed-off-by: Andy Lok <andylokandy@hotmail.com> * resolve ci Signed-off-by: Andy Lok <andylokandy@hotmail.com> * resolve ci Signed-off-by: Andy Lok <andylokandy@hotmail.com> * resolve ci Signed-off-by: Andy Lok <andylokandy@hotmail.com> --------- Signed-off-by: Andy Lok <andylokandy@hotmail.com>
tikv · Jul 13, 2023 · f799ab8 · f799ab8
1 parent c55e28e
commit f799ab8
Show file tree

Hide file tree

Showing 34 changed files with 306 additions and 206 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -27,8 +27,10 @@ jobs:
  override: true
  components: rustfmt, clippy
  - name: Check format
+ if: matrix.rust == 'nightly'
  run: cargo fmt --all -- --check
  - name: Lints
+ if: matrix.rust == 'nightly'
  run: cargo clippy --all-targets --all-features -- --deny warnings
  - name: Build
  run: cargo build --workspace --all-targets

diff --git a/Cargo.toml b/Cargo.toml
@@ -1,4 +1,5 @@
 [workspace]
+resolver = "2"
 members = [
  "minitrace",
  "minitrace-macro",

diff --git a/minitrace-datadog/Cargo.toml b/minitrace-datadog/Cargo.toml
@@ -3,7 +3,7 @@ name = "minitrace-datadog"
 version = "0.4.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
-edition = "2018"
+edition = "2021"
 description = "Datadog reporter for minitrace-rust"
 homepage = "https://github.com/tikv/minitrace-rust"
 repository = "https://github.com/tikv/minitrace-rust"
@@ -12,10 +12,10 @@ readme = "README.md"
 keywords = ["tracing", "span", "datadog", "jaeger", "opentracing"]
 
 [dependencies]
-minitrace = { path = "../minitrace" }
+minitrace = { version = "0.4.1", path = "../minitrace" }
+reqwest = { version = "0.11", features = ["blocking"] }
 rmp-serde = "1"
 serde = { version = "1", features = ["derive"] }
-reqwest = { version = "0.11", features = ["blocking"] }
 
 [dev-dependencies]
 futures = "0.3"
diff --git a/minitrace-jaeger/Cargo.toml b/minitrace-jaeger/Cargo.toml
@@ -3,7 +3,7 @@ name = "minitrace-jaeger"
 version = "0.4.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
-edition = "2018"
+edition = "2021"
 description = "Jaeger reporter for minitrace-rust"
 homepage = "https://github.com/tikv/minitrace-rust"
 repository = "https://github.com/tikv/minitrace-rust"
@@ -12,7 +12,7 @@ readme = "README.md"
 keywords = ["tracing", "span", "datadog", "jaeger", "opentracing"]
 
 [dependencies]
-minitrace = { path = "../minitrace" }
+minitrace = { version = "0.4.1", path = "../minitrace" }
 thrift_codec = "0.2"
 tokio = { version = "1", features = ["net"] }
 

diff --git a/minitrace-jaeger/src/lib.rs b/minitrace-jaeger/src/lib.rs
@@ -52,9 +52,13 @@ use minitrace::prelude::*;
 use thrift_codec::message::Message;
 use thrift_codec::CompactEncode;
 
-use crate::thrift::{
- Batch, EmitBatchNotification, Process, Span as JaegerSpan, SpanRef, SpanRefKind, Tag,
-};
+use crate::thrift::Batch;
+use crate::thrift::EmitBatchNotification;
+use crate::thrift::Process;
+use crate::thrift::Span as JaegerSpan;
+use crate::thrift::SpanRef;
+use crate::thrift::SpanRefKind;
+use crate::thrift::Tag;
 
 pub fn encode(
  service_name: String,

diff --git a/minitrace-jaeger/src/thrift.rs b/minitrace-jaeger/src/thrift.rs
@@ -4,7 +4,9 @@
 //!
 //! [jaeger.thrift]: https://github.com/uber/jaeger-idl/blob/master/thrift/jaeger.thrift
 
-use thrift_codec::data::{Field, List, Struct};
+use thrift_codec::data::Field;
+use thrift_codec::data::List;
+use thrift_codec::data::Struct;
 use thrift_codec::message::Message;
 
 #[derive(Debug, Clone)]

diff --git a/minitrace-macro/Cargo.toml b/minitrace-macro/Cargo.toml
@@ -3,7 +3,7 @@ name = "minitrace-macro"
 version = "0.4.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
-edition = "2018"
+edition = "2021"
 description = "Attribute procedural macro for minitrace-rust"
 homepage = "https://github.com/tikv/minitrace-rust"
 repository = "https://github.com/tikv/minitrace-rust"
@@ -16,12 +16,12 @@ proc-macro = true
 
 [dependencies]
 # 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-mut"] }
-quote = "1"
-proc-macro2 = "1"
 proc-macro-error = "1"
+proc-macro2 = "1"
+quote = "1"
+syn = { version = "1.0.84", features = ["full", "parsing", "extra-traits", "proc-macro", "visit-mut"] }
 
 [dev-dependencies]
-trybuild = "1"
-minitrace = "0.4.0"
+minitrace = { version = "0.4.1", path = "../minitrace" }
 tokio = { version = "1", features = ["full"] }
+trybuild = "1"
diff --git a/minitrace-macro/src/lib.rs b/minitrace-macro/src/lib.rs
@@ -11,11 +11,16 @@ extern crate proc_macro;
 #[macro_use]
 extern crate proc_macro_error;
 
+use proc_macro2::Span;
 use proc_macro2::TokenStream;
-use proc_macro2::{Span, TokenTree};
-use quote::{format_ident, quote_spanned};
+use proc_macro2::TokenTree;
+use quote::format_ident;
+use quote::quote_spanned;
+use syn::punctuated::Punctuated;
 use syn::spanned::Spanned;
-use syn::{punctuated::Punctuated, visit_mut::VisitMut, Ident, *};
+use syn::visit_mut::VisitMut;
+use syn::Ident;
+use syn::*;
 
 struct Args {
  event: String,

diff --git a/minitrace/Cargo.toml b/minitrace/Cargo.toml
@@ -3,7 +3,7 @@ name = "minitrace"
 version = "0.4.1"
 authors = ["The TiKV Project Authors"]
 license = "Apache-2.0"
-edition = "2018"
+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"
@@ -12,11 +12,11 @@ readme = "../README.md"
 keywords = ["tracing", "span", "datadog", "jaeger", "opentracing"]
 
 [dependencies]
+futures = "0.3"
+minitrace-macro = { version = "0.4.1", path = "../minitrace-macro" }
 minstant = "0.1"
-minitrace-macro = { path = "../minitrace-macro" }
-pin-project = "1.0"
 parking_lot = "0.12"
-futures = "0.3"
+pin-project = "1.0"
 # TODO: Remove once_cell once #![feature(once_cell)] is stabilized
 once_cell = "1"
 
@@ -25,22 +25,22 @@ once_cell = "1"
 async-trait = "0.1.52"
 criterion = { version = "0.4", features = ["html_reports"] }
 crossbeam = "0.8"
-minitrace-jaeger = { path = "../minitrace-jaeger" }
-minitrace-datadog = { path = "../minitrace-datadog" }
-tokio = { version = "1", features = ["rt", "time", "macros"] }
-rustracing = "0.6"
+env_logger = "0.10"
+futures = "0.3"
+futures-timer = "3"
+log = "0.4"
+minitrace-datadog = { version = "0.4.1", path = "../minitrace-datadog" }
+minitrace-jaeger = { version = "0.4.1", path = "../minitrace-jaeger" }
+mockall = "0.11"
 opentelemetry = { version = "0.18", default-features = false, features = ["trace"] }
 opentelemetry-jaeger = "0.17"
-tracing-opentelemetry = "0.18"
+rand = "0.8"
+rustracing = "0.6"
+tokio = { version = "1", features = ["rt", "time", "macros"] }
 tracing = "0.1"
 tracing-core = "0.1"
+tracing-opentelemetry = "0.18"
 tracing-subscriber = "0.3"
-rand = "0.8"
-futures = "0.3"
-futures-timer = "3"
-mockall = "0.11"
-log = "0.4"
-env_logger = "0.10"
 
 [[bench]]
 name = "trace"

diff --git a/minitrace/benches/compare.rs b/minitrace/benches/compare.rs
@@ -1,6 +1,8 @@
 // Copyright 2020 TiKV Project Authors. Licensed under Apache-2.0.
 
-use criterion::{criterion_group, criterion_main, Criterion};
+use criterion::criterion_group;
+use criterion::criterion_main;
+use criterion::Criterion;
 
 fn init_opentelemetry() {
  use tracing_subscriber::prelude::*;

diff --git a/minitrace/benches/object_pool.rs b/minitrace/benches/object_pool.rs
@@ -1,6 +1,9 @@
 // Copyright 2022 TiKV Project Authors. Licensed under Apache-2.0.
 
-use criterion::{criterion_group, criterion_main, BatchSize, Criterion};
+use criterion::criterion_group;
+use criterion::criterion_main;
+use criterion::BatchSize;
+use criterion::Criterion;
 use minitrace::util::object_pool::Pool;
 
 fn bench_alloc_vec(c: &mut Criterion) {

diff --git a/minitrace/benches/spsc.rs b/minitrace/benches/spsc.rs
@@ -1,6 +1,8 @@
 // Copyright 2022 TiKV Project Authors. Licensed under Apache-2.0.
 
-use criterion::{criterion_group, criterion_main, Criterion};
+use criterion::criterion_group;
+use criterion::criterion_main;
+use criterion::Criterion;
 
 fn crossbeam(nmsg: usize) {
  let (tx, rx) = crossbeam::channel::bounded(10240);

diff --git a/minitrace/benches/trace.rs b/minitrace/benches/trace.rs
@@ -1,6 +1,9 @@
 // Copyright 2020 TiKV Project Authors. Licensed under Apache-2.0.
 
-use criterion::{black_box, criterion_group, criterion_main, Criterion};
+use criterion::black_box;
+use criterion::criterion_group;
+use criterion::criterion_main;
+use criterion::Criterion;
 use minitrace::local::LocalCollector;
 use minitrace::prelude::*;
 

diff --git a/minitrace/src/collector/command.rs b/minitrace/src/collector/command.rs
@@ -1,6 +1,8 @@
 // Copyright 2022 TiKV Project Authors. Licensed under Apache-2.0.
 
-use crate::collector::{CollectArgs, SpanRecord, SpanSet};
+use crate::collector::CollectArgs;
+use crate::collector::SpanRecord;
+use crate::collector::SpanSet;
 use crate::util::CollectToken;
 
 pub enum CollectCommand {

diff --git a/minitrace/src/collector/global_collector.rs b/minitrace/src/collector/global_collector.rs
@@ -1,24 +1,31 @@
 // Copyright 2021 TiKV Project Authors. Licensed under Apache-2.0.
 
-use crate::collector::command::{
- CollectCommand, CommitCollect, DropCollect, StartCollect, SubmitSpans,
-};
-use crate::collector::{CollectArgs, SpanRecord, SpanSet};
-use crate::local::raw_span::RawSpan;
-use crate::local::span_id::SpanId;
-use crate::local::LocalSpans;
-use crate::util::spsc::{self, Receiver, Sender};
-use crate::util::CollectToken;
-
 use std::collections::HashMap;
-use std::sync::atomic::{AtomicU32, Ordering};
+use std::sync::atomic::AtomicU32;
+use std::sync::atomic::Ordering;
 use std::sync::Arc;
 use std::time::Duration;
 
 use minstant::Anchor;
 use once_cell::sync::Lazy;
 use parking_lot::Mutex;
 
+use crate::collector::command::CollectCommand;
+use crate::collector::command::CommitCollect;
+use crate::collector::command::DropCollect;
+use crate::collector::command::StartCollect;
+use crate::collector::command::SubmitSpans;
+use crate::collector::CollectArgs;
+use crate::collector::SpanRecord;
+use crate::collector::SpanSet;
+use crate::local::raw_span::RawSpan;
+use crate::local::span_id::SpanId;
+use crate::local::LocalSpans;
+use crate::util::spsc::Receiver;
+use crate::util::spsc::Sender;
+use crate::util::spsc::{self};
+use crate::util::CollectToken;
+
 const COLLECT_LOOP_INTERVAL: Duration = Duration::from_millis(10);
 
 static NEXT_COLLECT_ID: AtomicU32 = AtomicU32::new(0);
@@ -128,10 +135,14 @@ impl GlobalCollector {
  fn start() -> Self {
  std::thread::Builder::new()
  .name("minitrace".to_string())
- .spawn(move || loop {
- let begin_instant = std::time::Instant::now();
- GLOBAL_COLLECTOR.lock().handle_commands();
- std::thread::sleep(COLLECT_LOOP_INTERVAL.saturating_sub(begin_instant.elapsed()));
+ .spawn(move || {
+ loop {
+ let begin_instant = std::time::Instant::now();
+ GLOBAL_COLLECTOR.lock().handle_commands();
+ std::thread::sleep(
+ COLLECT_LOOP_INTERVAL.saturating_sub(begin_instant.elapsed()),
+ );
+ }
  })
  .unwrap();
 
@@ -161,18 +172,20 @@ impl GlobalCollector {
  let commit_collects = &mut self.commit_collects;
  let submit_spans = &mut self.submit_spans;
 
- self.rxs.retain_mut(|rx| loop {
- match rx.try_recv() {
- Ok(Some(CollectCommand::StartCollect(cmd))) => start_collects.push(cmd),
- Ok(Some(CollectCommand::DropCollect(cmd))) => drop_collects.push(cmd),
- Ok(Some(CollectCommand::CommitCollect(cmd))) => commit_collects.push(cmd),
- Ok(Some(CollectCommand::SubmitSpans(cmd))) => submit_spans.push(cmd),
- Ok(None) => {
- return true;
- }
- Err(_) => {
- // Channel disconnected. It must be because the sender thread has stopped.
- return false;
+ self.rxs.retain_mut(|rx| {
+ loop {
+ match rx.try_recv() {
+ Ok(Some(CollectCommand::StartCollect(cmd))) => start_collects.push(cmd),
+ Ok(Some(CollectCommand::DropCollect(cmd))) => drop_collects.push(cmd),
+ Ok(Some(CollectCommand::CommitCollect(cmd))) => commit_collects.push(cmd),
+ Ok(Some(CollectCommand::SubmitSpans(cmd))) => submit_spans.push(cmd),
+ Ok(None) => {
+ return true;
+ }
+ Err(_) => {
+ // Channel disconnected. It must be because the sender thread has stopped.
+ return false;
+ }
  }
  }
  });